fix(docs/content): improvements of docs navigation by adding links #1774

Dkwcs · 2024-08-13T11:53:26Z

Description of change

Minor enhancement of exchanges.mdx file navigation by adding additional links.

Type of change

Enhancement (a non-breaking change which adds functionality)

How the change has been tested

pnpm iota-docs dev

…f-read-migration-docs

Dkwcs · 2024-08-13T13:09:40Z

Also I'm a bit confused with the address format:
Exchanges & Custody Providers says:

Existing addresses will remain the same in their hex format. However, the Bech32 human-readable format (identified by the iota1 prefix) will no longer be available

Addresses and Keys says:

Bech32 to Hex conversion
It's possible to convert a legacy Bech32 address back to hex format by doing the following:
Take the part after iota1 or smr1. Using the address from the above paragraph as an example, iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx.
Base32 decode it.
Strip away the last 6 digits containing the checksum.
You are left with a 33-byte hex string. The first byte represents the address type (0x00) and can be stripped. The 32 bytes represent an address in hex format.

Units and Conversions says:

Example
You own 1.234567 IOTA on Stardust on address iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx.
This address is represented as 0xefdc112efe262b304bcf379b26c31bad029f616ee3ec4aa6345a366e4c9e43a3 in hex format.

Is there any sense to provide iota1... address format as example, etc - if it marked as "no longer be available"?

@iotaledger/devx

github-actions · 2024-08-13T13:18:16Z

✅ Vercel Preview Deployment is ready!

View Preview

…nks for OTW, Bag, Coin, Unlock Condition

github-actions · 2024-08-13T20:09:02Z

✅ Vercel Preview Deployment is ready!

View Preview

miker83z

Looks good, great work!

valeriyr · 2024-08-14T08:27:57Z

docs/content/developer/stardust/claiming/alias.mdx

@@ -26,8 +26,8 @@ A Governor address can claim the `AliasOutput` assets at any time:


 2. Then we check the native tokens that were possibly held by this output.
-A `Bag` is used for holding these tokens, so in this step we are interested in obtaining the dynamic field keys that are bag indexes.
-In the case of the native tokens, the keys are strings representing the `OTW` used for the native token declaration.
+A [`Bag`](../../../references/framework/iota-framework/bag) is used for holding these tokens, so in this step we are interested in obtaining the dynamic field keys that are bag indexes.


Is it necessary to add .mdx at the end of the path?
Sometimes it is added to the paths in the PR, sometimes it is not.

Also, a question, if we use a link in the format [](), do we need to add quotes to the name [`Bag`]? It seems unnecessary.

@valeriyr

Also, a question, if we use a link in the format , do we need to add quotes to the name [Bag]? It seems unnecessary.

It still makes the background of the word to become gray, so it is graphically nice.

Without .mdx it works anyway, but for a strict style and structure I'll add missing file extensions

Just fyi, extensions should be added as a best practice, most editors can be configured to have autocompletion for file paths so this is also convenient. Especially if you refactor docs as editors can suggest to change the paths for you. Also for versioning it is pretty important

…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]>

* 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]>

fix(docs/content): improvements of docs navigation by adding links

78b971b

Dkwcs requested review from valeriyr and miker83z August 13, 2024 11:53

github-actions bot added the Type: Documentation label Aug 13, 2024

Dkwcs added the sc-platform Issues related to the Smart Contract Platform group. label Aug 13, 2024

Dkwcs self-assigned this Aug 13, 2024

Dkwcs added 2 commits August 13, 2024 16:02

fix(docs/content): add additional links, readable improvements.

318eed1

Merge branch 'vm-language/stardust-models-docs' into sc-platform/proo…

08abfa6

…f-read-migration-docs

Dkwcs marked this pull request as ready for review August 13, 2024 13:12

Dkwcs requested a review from a team as a code owner August 13, 2024 13:12

lucas-tortora approved these changes Aug 13, 2024

View reviewed changes

fix(docs/content/../claiming): simplify navigation with additional li…

7099a1e

…nks for OTW, Bag, Coin, Unlock Condition

miker83z approved these changes Aug 14, 2024

View reviewed changes

valeriyr reviewed Aug 14, 2024

View reviewed changes

valeriyr approved these changes Aug 14, 2024

View reviewed changes

miker83z merged commit fb392c4 into vm-language/stardust-models-docs Aug 14, 2024
33 of 34 checks passed

miker83z deleted the sc-platform/proof-read-migration-docs branch August 14, 2024 09:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs/content): improvements of docs navigation by adding links #1774

fix(docs/content): improvements of docs navigation by adding links #1774

Dkwcs commented Aug 13, 2024 •

edited

Loading

Dkwcs commented Aug 13, 2024 •

edited

Loading

github-actions bot commented Aug 13, 2024

github-actions bot commented Aug 13, 2024

miker83z left a comment

valeriyr Aug 14, 2024 •

edited

Loading

miker83z Aug 14, 2024

Dkwcs Aug 14, 2024

Dr-Electron Aug 19, 2024

fix(docs/content): improvements of docs navigation by adding links #1774

fix(docs/content): improvements of docs navigation by adding links #1774

Conversation

Dkwcs commented Aug 13, 2024 • edited Loading

Description of change

Type of change

How the change has been tested

Dkwcs commented Aug 13, 2024 • edited Loading

github-actions bot commented Aug 13, 2024

github-actions bot commented Aug 13, 2024

miker83z left a comment

Choose a reason for hiding this comment

valeriyr Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

miker83z Aug 14, 2024

Choose a reason for hiding this comment

Dkwcs Aug 14, 2024

Choose a reason for hiding this comment

Dr-Electron Aug 19, 2024

Choose a reason for hiding this comment

Dkwcs commented Aug 13, 2024 •

edited

Loading

Dkwcs commented Aug 13, 2024 •

edited

Loading

valeriyr Aug 14, 2024 •

edited

Loading