Improve README Documentation for @solana/actions SDK #54
+51
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mooncitydev
reviewed
Apr 23, 2025
There was a problem hiding this comment.
This was so much of a distraction for me that, wow, I've distracted myself further by making this PR.
The word, "unknown" in this message is at best unneeded and at worst deceptive. The error is almost certainly known. It was passed to the catch. We could figure it out. We could code to it. What we're doing is punting, because writing a bunch of error detecting code would be a distraction here. So, let's be honest about it. An error occurred. It is not unknown. We're simply punting it out.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the README documentation for the @solana/actions SDK to make it more comprehensive and user-friendly. Changes include:
Added clear links to the Typedoc documentation.
Included the npm installs badge for visibility.
Added example code snippets for commonly used functions, including:
createActionHeaders
Creating a typed actions.json payload
Creating typed GET and POST request/response payloads.
Improved overall formatting for readability and consistency.
Ensured that the root repo README and the @solana/actions package README are mirrored.
These changes aim to enhance the onboarding experience for developers using the SDK.
Testing:
Verified that the code snippets align with the current SDK functionality.
Checked all links to ensure they are working as expected.
Related Issue:
Closes #41.
This pull request was created for https://app.gib.work/bounties/a6ece26a-1d3d-4186-b072-70d244c43569 in an attempt to solve a bounty #41 . Payment for the bounty is immediately sent to the contributor after merge.