fix(docs/content): Enhance claiming docs and fix links #1768
Conversation
This file contains 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
miker83z
added
the
sc-platform
|
✅ Vercel Preview Deployment is ready! |
Dkwcs
approved these changes
Aug 13, 2024
valeriyr
approved these changes
Aug 13, 2024
miker83z
merged commit 2a9fb5f
into
vm-language/stardust-models-docs
33 of 34 checks passed
valeriyr
added a commit
that referenced
this pull request
Aug 22, 2024
…ock outputs, documentation enhancement (#1862) * feat(docs): Create an examples folder for Rust code (#1503) * feat(docs): create an example folder for Rust code * Update docs/examples/rust/Cargo.toml --------- Co-authored-by: Dr-Electron <[email protected]> * fix(docs/examples): remove base_keystore example * feat(iota-sdk): added an alias output claim example (#1493) * feat(iota-sdk): added an alias output claim example * feat(docs): moved the alias output claim example * refactor(docs): used the extract_and_send_to function to simplify the example * fix(docs): added a license header and an example description * fix(docs): alias-output-claim comments * fix(docs): clippy * fix(docs): move the alias-output-claim example into the stardust subfolder * fix(docs): fixed the example after rebasing * fix(docs): move the alias-output-claim example * fix(docs): alias-output-claim logs improved * feat(iota-sdk): add basic output claim example * fix(iota-sdk): use the proper native token bag key * fix(iota-sdk): move basic output example in docs * fix(docs/examples): comments * fix(docs/examples): license header * fix(docs/examples): basic output address * fix(docs/examples): fix clippy * fix(docs/examples): fix from comments * fix(docs/examples): move basic output example * fix(docs/examples): remove src folder * feat(docs/examples): nft output extraction example based on sdk (#1478) * feat(docs): add nft output claiming test example based on sdk usage * feat(ci): add docs examples in rust (#1539) * fix(docs/examples): add license * fix(docs/examples): cargo lock * chore(docs/examples): add clarification comment * feat(docs/examples): add unlock condition example based on rust sdk (#1559) * feat(docs): add unlock condition example based on rust sdk Add fund_address function for sponsoring the main transaction * feat(docs/examples): Add foundry output claim example (#1575) * feat(docs/examples): ad foundry output claim * fix(docs/examples): cargo toml and clones * feat(docs/examples): Test the positive scenarios for using an NFT object (#1615) * Add example of third party simple nft package, PTB that creates custom nft from stardust::nft Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * feat(docs/stardust): Add docs for basic output claim (#1639) * feat(docs/stardust): add docs for basic output claim * Update docs/examples/rust/stardust/check-basic-output-unlock-conditions.rs Co-authored-by: Thoralf-M <[email protected]> * Update docs/examples/rust/stardust/check-basic-output-unlock-conditions.rs Co-authored-by: Thoralf-M <[email protected]> --------- Co-authored-by: Thoralf-M <[email protected]> * feat(docs/content): documentation - claim NFT Output (#1654) * feat(docs/content): documentation - claim NFT Output * fear(docs/content) example of conversion of a stardust NFT into a custom user's. (#1669) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * Review comment fixes * Fix Nft naming * Fix review comments --------- Co-authored-by: Mirko Zichichi <[email protected]> * feat(docs): Using an Alias object test scenario (#1679) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * feat(docs): extended the custom_nft package with collections * Review comment fixes * Fix Nft naming * fix(docs): NFTs conversion docs were fixed after refactoring * fix(docs): spelling issues --------- Co-authored-by: Dkwcs <[email protected]> * refactor(docs/content): Split claiming docs in a tree (#1710) * refactor(docs/content): split claiming docs in a tree * feat(docs/content): add address unlock condition claim * fix(docs/content): claiming references * fix(docs/content): claiming references 2 * chore(docs): fix doc tree for claiming --------- Co-authored-by: Levente Pap <[email protected]> * feat(docs): Alias usage documentation was added (#1723) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * feat(docs): extended the custom_nft package with collections * Review comment fixes * Fix Nft naming * fix(docs): NFTs conversion docs were fixed after refactoring * fix(docs): spelling issues * feat(docs): added alias documentation * fix(docs): spelling issues * fix(docs): review comments --------- Co-authored-by: Dkwcs <[email protected]> * feat(docs/content): docs implementation for address unlock condition example (#1706) * feat(docs/content): docs impl for address unlock condition * feat(docs/content): Create example doc for claiming a Foundry Output (#1724) * feat(docs/content): add doc example of claiming foundry output * fix(docs/content): enhance claiming and fix links (#1768) * feat(docs/examples): Add self sponsor example for Shimmer assets (#1772) * feat(docs/examples): add self sponsor example * fix(docs/content): make self sponsor example for Shimmer * fix(docs/examples): smr comment * fix(docs/examples): dprint * fix(docs/examples): remove double comment Co-authored-by: Thoralf-M <[email protected]> * fix(docs/examples): client server comments --------- Co-authored-by: Thoralf-M <[email protected]> * feat(docs/content): Add Shimmer self-sponsorship claim docs (#1773) * feat(docs/examples): add self sponsor example * fix(docs/content): make self sponsor example for Shimmer * fix(docs/examples): smr comment * fix(docs/examples): dprint * feat(docs/content): add shimmer self-sponsorship claim * fix(docs/content): spaces Co-authored-by: Thoralf-M <[email protected]> * fix(docs/content): code lines --------- Co-authored-by: Thoralf-M <[email protected]> * fix(docs/content): improvements of docs navigation by adding links (#1774) * fix(docs/content): improvements of docs navigation by adding links * fix(docs/content): add additional links, readable improvements. * fix(docs/content/../claiming): simplify navigation with additional links for OTW, Bag, Coin, Unlock Condition * refactor(docs/examples): Create a utility methods lib (#1821) * refactor(docs/examples): create a utility methods lib * refactor(docs/examples): update examples * refactor(docs/content): update examples code lines in docs * fix(docs/examples): move module path * fix(docs/examples): address uc name * Update docs/examples/rust/src/lib.rs Co-authored-by: Thoralf-M <[email protected]> * Update docs/content/developer/stardust/claiming/nft.mdx Co-authored-by: Thoralf-M <[email protected]> * fix(docs/examples): move utils out of lib --------- Co-authored-by: Thoralf-M <[email protected]> --------- Co-authored-by: Mirko Zichichi <[email protected]> Co-authored-by: Dr-Electron <[email protected]> Co-authored-by: Valerii Reutov <[email protected]> Co-authored-by: Thoralf-M <[email protected]> Co-authored-by: Levente Pap <[email protected]>
valeriyr
added a commit
that referenced
this pull request
Aug 22, 2024
* feat(docs): Create an examples folder for Rust code (#1503) * feat(docs): create an example folder for Rust code * Update docs/examples/rust/Cargo.toml --------- Co-authored-by: Dr-Electron <[email protected]> * fix(docs/examples): remove base_keystore example * feat(iota-sdk): added an alias output claim example (#1493) * feat(iota-sdk): added an alias output claim example * feat(docs): moved the alias output claim example * refactor(docs): used the extract_and_send_to function to simplify the example * fix(docs): added a license header and an example description * fix(docs): alias-output-claim comments * fix(docs): clippy * fix(docs): move the alias-output-claim example into the stardust subfolder * fix(docs): fixed the example after rebasing * fix(docs): move the alias-output-claim example * fix(docs): alias-output-claim logs improved * feat(iota-sdk): add basic output claim example * fix(iota-sdk): use the proper native token bag key * fix(iota-sdk): move basic output example in docs * fix(docs/examples): comments * fix(docs/examples): license header * fix(docs/examples): basic output address * fix(docs/examples): fix clippy * fix(docs/examples): fix from comments * fix(docs/examples): move basic output example * fix(docs/examples): remove src folder * feat(docs/examples): nft output extraction example based on sdk (#1478) * feat(docs): add nft output claiming test example based on sdk usage * feat(ci): add docs examples in rust (#1539) * fix(docs/examples): add license * fix(docs/examples): cargo lock * chore(docs/examples): add clarification comment * feat(docs/examples): add unlock condition example based on rust sdk (#1559) * feat(docs): add unlock condition example based on rust sdk Add fund_address function for sponsoring the main transaction * feat(docs/examples): Add foundry output claim example (#1575) * feat(docs/examples): ad foundry output claim * fix(docs/examples): cargo toml and clones * feat(docs/examples): Test the positive scenarios for using an NFT object (#1615) * Add example of third party simple nft package, PTB that creates custom nft from stardust::nft Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * feat(docs/stardust): Add docs for basic output claim (#1639) * feat(docs/stardust): add docs for basic output claim * Update docs/examples/rust/stardust/check-basic-output-unlock-conditions.rs Co-authored-by: Thoralf-M <[email protected]> * Update docs/examples/rust/stardust/check-basic-output-unlock-conditions.rs Co-authored-by: Thoralf-M <[email protected]> --------- Co-authored-by: Thoralf-M <[email protected]> * feat(docs/content): documentation - claim NFT Output (#1654) * feat(docs/content): documentation - claim NFT Output * fear(docs/content) example of conversion of a stardust NFT into a custom user's. (#1669) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * Review comment fixes * Fix Nft naming * Fix review comments --------- Co-authored-by: Mirko Zichichi <[email protected]> * feat(docs): Using an Alias object test scenario (#1679) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * feat(docs): extended the custom_nft package with collections * Review comment fixes * Fix Nft naming * fix(docs): NFTs conversion docs were fixed after refactoring * fix(docs): spelling issues --------- Co-authored-by: Dkwcs <[email protected]> * refactor(docs/content): Split claiming docs in a tree (#1710) * refactor(docs/content): split claiming docs in a tree * feat(docs/content): add address unlock condition claim * fix(docs/content): claiming references * fix(docs/content): claiming references 2 * chore(docs): fix doc tree for claiming --------- Co-authored-by: Levente Pap <[email protected]> * feat(docs): Alias usage documentation was added (#1723) * Add example ofr third party simple nft package, PTB that create custom nft from stardust::nft * feat(examples/docs): Add a conversion function for custom NFTs to allow migrating custom NFTs from Stardust NFTs * Add function that publishes random nft package via CLI. * feat(examples): replace package publishing approach with iota-move-builder * Fix chkecs * Minor refactoring * dprint fix * Fix review comments * feat(docs/content): add doc related to conversion of a NFT Output into sutom NFT * feat(docs): extended the custom_nft package with collections * Review comment fixes * Fix Nft naming * fix(docs): NFTs conversion docs were fixed after refactoring * fix(docs): spelling issues * feat(docs): added alias documentation * fix(docs): spelling issues * fix(docs): review comments --------- Co-authored-by: Dkwcs <[email protected]> * feat(docs/content): docs implementation for address unlock condition example (#1706) * feat(docs/content): docs impl for address unlock condition * feat(docs/content): Create example doc for claiming a Foundry Output (#1724) * feat(docs/content): add doc example of claiming foundry output * fix(docs/content): enhance claiming and fix links (#1768) * feat(docs/examples): Add self sponsor example for Shimmer assets (#1772) * feat(docs/examples): add self sponsor example * fix(docs/content): make self sponsor example for Shimmer * fix(docs/examples): smr comment * fix(docs/examples): dprint * fix(docs/examples): remove double comment Co-authored-by: Thoralf-M <[email protected]> * fix(docs/examples): client server comments --------- Co-authored-by: Thoralf-M <[email protected]> * feat(docs/content): Add Shimmer self-sponsorship claim docs (#1773) * feat(docs/examples): add self sponsor example * fix(docs/content): make self sponsor example for Shimmer * fix(docs/examples): smr comment * fix(docs/examples): dprint * feat(docs/content): add shimmer self-sponsorship claim * fix(docs/content): spaces Co-authored-by: Thoralf-M <[email protected]> * fix(docs/content): code lines --------- Co-authored-by: Thoralf-M <[email protected]> * fix(docs/content): improvements of docs navigation by adding links (#1774) * fix(docs/content): improvements of docs navigation by adding links * fix(docs/content): add additional links, readable improvements. * fix(docs/content/../claiming): simplify navigation with additional links for OTW, Bag, Coin, Unlock Condition * refactor(docs/examples): Create a utility methods lib (#1821) * refactor(docs/examples): create a utility methods lib * refactor(docs/examples): update examples * refactor(docs/content): update examples code lines in docs * fix(docs/examples): move module path * fix(docs/examples): address uc name * Update docs/examples/rust/src/lib.rs Co-authored-by: Thoralf-M <[email protected]> * Update docs/content/developer/stardust/claiming/nft.mdx Co-authored-by: Thoralf-M <[email protected]> * fix(docs/examples): move utils out of lib --------- Co-authored-by: Thoralf-M <[email protected]> * fix(docs/content): add links to simplify docs navigation * feat(docs): Move content was fixed in the Developer/Getting Started documentation part * fix(docs/context): add links, minor docs refactoring * fix(docs/content): documentation code examples enhancement * fix(docs): fixed tokenomics link --------- Co-authored-by: Mirko Zichichi <[email protected]> Co-authored-by: Dr-Electron <[email protected]> Co-authored-by: Valerii Reutov <[email protected]> Co-authored-by: Thoralf-M <[email protected]> Co-authored-by: Levente Pap <[email protected]> Co-authored-by: Thibault Martinez <[email protected]>
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.
Description of change
Just a small change to the
claiming.mdxandmove-models.mdxin order to fix #1045.Type of change
How the change has been tested
pnpm iota-docs devChange checklist