Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs StakeWise SDK documentation by aligning an API page slug with the established /requests/ URL structure and adding a set of “Quick start” guides that demonstrate common vault and osToken workflows using the SDK.
Changes:
- Updated the
getOsTokenConfigAPI doc slug to the/sdk/api/vault/requests/...pattern. - Added new quick-start guides for vault/user data retrieval and core actions (deposit, unstake, mint/burn osToken, boost/unboost).
Reviewed changes
Copilot reviewed 1 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sdk/API/01-vault/getOsTokenConfig.md | Adjusts the API page slug to match the requests URL convention. |
| docs/sdk/03-quick-start/get-vault-data.md | New example for fetching vault-level data (vault, stats, validators, lists). |
| docs/sdk/03-quick-start/get-user-data.md | New example for aggregating user-level vault data (balances, queues, actions, rewards). |
| docs/sdk/03-quick-start/deposit-to-vault.md | New deposit guide with browser and backend/custodial flows (backend snippet currently inconsistent with encoding guidance). |
| docs/sdk/03-quick-start/unstake.md | New unstake example including max-withdraw + exit queue retrieval. |
| docs/sdk/03-quick-start/mint-os-token.md | New osToken mint example (contains a deprecated-method reference in prose and some unused code). |
| docs/sdk/03-quick-start/burn-os-token.md | New osToken burn example (health factor computation uses shares where assets are required). |
| docs/sdk/03-quick-start/boost.md | New boost example (permit param handling causes TS/runtime issues; includes unused import). |
| docs/sdk/03-quick-start/unboost.md | New unboost example (contains unused imports/types). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Automatic SDK Documentation Sync