XCM Cookbook (#2633)
# Context
XCM docs are currently an md book hosted with github pages:
https://paritytech.github.io/xcm-docs/.
While that's fine, it's not in line with the work being done in the
polkadot-sdk docs.
# Main addition
This PR aims to fix that by bringing the docs back to this repo.
This does not have all the information currently present in the mdbook
xcm-docs but aims to be a good chunk of it and fully replace it over
time.
I also added the sections `guides` and `cookbook` which will be very
useful for users wanting to get into XCM.
For now I only added one example to the cookbook, but have ideas for
guides and more examples.
Having this docs be in rust docs is very useful for the cookbook.
# TODO
- [x] Use `FungibleAdapter`
- [x] Improve and relocate mock message queue
- [x] Fix license issue. Why does docs/sdk/ not have this problem? (Just
added the licenses)
# Next steps
- More examples in the cookbook
- End-to-end XCM guide with zombienet testing
---------
Co-authored-by: command-bot <>
Co-authored-by:
joe petrowski <25483142+joepetrowski@users.noreply.github.com>
parent
d237adfb
Showing
- Cargo.lock 59 additions, 3 deletionsCargo.lock
- Cargo.toml 1 addition, 0 deletionsCargo.toml
- polkadot/xcm/docs/Cargo.toml 39 additions, 0 deletionspolkadot/xcm/docs/Cargo.toml
- polkadot/xcm/docs/mermaid/location_hierarchy.mmd 9 additions, 0 deletionspolkadot/xcm/docs/mermaid/location_hierarchy.mmd
- polkadot/xcm/docs/mermaid/structure.mmd 4 additions, 0 deletionspolkadot/xcm/docs/mermaid/structure.mmd
- polkadot/xcm/docs/mermaid/transport_protocols.mmd 6 additions, 0 deletionspolkadot/xcm/docs/mermaid/transport_protocols.mmd
- polkadot/xcm/docs/mermaid/universal_location.mmd 3 additions, 0 deletionspolkadot/xcm/docs/mermaid/universal_location.mmd
- polkadot/xcm/docs/mermaid/usdt_location.mmd 6 additions, 0 deletionspolkadot/xcm/docs/mermaid/usdt_location.mmd
- polkadot/xcm/docs/src/cookbook/mod.rs 27 additions, 0 deletionspolkadot/xcm/docs/src/cookbook/mod.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/mod.rs 51 additions, 0 deletionspolkadot/xcm/docs/src/cookbook/relay_token_transactor/mod.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/network.rs 90 additions, 0 deletions...t/xcm/docs/src/cookbook/relay_token_transactor/network.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/parachain/mod.rs 56 additions, 0 deletions...docs/src/cookbook/relay_token_transactor/parachain/mod.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/parachain/xcm_config.rs 189 additions, 0 deletions...c/cookbook/relay_token_transactor/parachain/xcm_config.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/relay_chain/mod.rs 103 additions, 0 deletions...cs/src/cookbook/relay_token_transactor/relay_chain/mod.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/relay_chain/xcm_config.rs 163 additions, 0 deletions...cookbook/relay_token_transactor/relay_chain/xcm_config.rs
- polkadot/xcm/docs/src/cookbook/relay_token_transactor/tests.rs 128 additions, 0 deletions...dot/xcm/docs/src/cookbook/relay_token_transactor/tests.rs
- polkadot/xcm/docs/src/fundamentals.rs 177 additions, 0 deletionspolkadot/xcm/docs/src/fundamentals.rs
- polkadot/xcm/docs/src/glossary.rs 123 additions, 0 deletionspolkadot/xcm/docs/src/glossary.rs
- polkadot/xcm/docs/src/guides/mod.rs 25 additions, 0 deletionspolkadot/xcm/docs/src/guides/mod.rs
- polkadot/xcm/docs/src/lib.rs 63 additions, 0 deletionspolkadot/xcm/docs/src/lib.rs
Please register or sign in to comment