diff --git a/Makefile b/Makefile index 757d0576..53e41999 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ build-fuzz: readme: cd soroban-sdk \ - && cargo +nightly rustdoc -- -Zunstable-options -wjson \ + && cargo +nightly rustdoc --features testutils -- -Zunstable-options -wjson \ && cat ../target/doc/soroban_sdk.json \ | jq -r '.index[.root|tostring].docs' \ > README.md diff --git a/soroban-sdk/README.md b/soroban-sdk/README.md index 83953317..9d61e1b6 100644 --- a/soroban-sdk/README.md +++ b/soroban-sdk/README.md @@ -1,9 +1,17 @@ -Soroban SDK supports writing programs for the Soroban smart contract -platform. +Soroban SDK supports writing smart contracts for the [Soroban] smart contract +Wasm-powered runtime, that is deployed on [Stellar]. ### Docs -See [soroban.stellar.org](https://soroban.stellar.org) for documentation. +See [developers.stellar.org] for documentation about building smart contracts for [Stellar]. + +[developers.stellar.org]: https://developers.stellar.org +[Stellar]: https://stellar.org +[Soroban]: https://stellar.org/soroban + +### Migrating Major Versions + +See [_migrating] for a summary of how to migrate from one major version to another. ### Examples @@ -37,5 +45,6 @@ fn test() { # fn main() { } ``` -More examples are available at -and . +More examples are available at: +- +- diff --git a/soroban-sdk/src/lib.rs b/soroban-sdk/src/lib.rs index 26d6fd45..67f08722 100644 --- a/soroban-sdk/src/lib.rs +++ b/soroban-sdk/src/lib.rs @@ -1,4 +1,5 @@ -//! Soroban SDK supports writing smart contracts for Stellar. +//! Soroban SDK supports writing smart contracts for the [Soroban] smart contract +//! Wasm-powered runtime, that is deployed on [Stellar]. //! //! ### Docs //! @@ -6,6 +7,7 @@ //! //! [developers.stellar.org]: https://developers.stellar.org //! [Stellar]: https://stellar.org +//! [Soroban]: https://stellar.org/soroban //! //! ### Migrating Major Versions //!