From 0759b666cebf62ef07a20d0075a2dd395ba3b462 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 20 Oct 2021 01:53:55 +0000 Subject: [PATCH] Expand Rust API docs entry point (#20770) (#20801) (cherry picked from commit cc4bb5a451a600e64d10e98dcb15bb29fe951cab) Co-authored-by: Brian Anderson --- docs/src/developing/clients/rust-api.md | 31 +++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/src/developing/clients/rust-api.md b/docs/src/developing/clients/rust-api.md index ec6555fa1c..8ec1eea882 100644 --- a/docs/src/developing/clients/rust-api.md +++ b/docs/src/developing/clients/rust-api.md @@ -2,7 +2,30 @@ title: Rust API --- -See [doc.rs](https://docs.rs/releases/search?query=solana-) for documentation of -all crates published by Solana. In particular [solana-sdk](https://docs.rs/solana-sdk) -for working with common data structures and [solana-client](https://docs.rs/solana-client) -for querying the [JSON RPC API](jsonrpc-api). +Solana's Rust crates are [published to crates.io][crates.io] and can be found +[on docs.rs with the "solana-" prefix][docs.rs]. + +[crates.io]: https://crates.io/search?q=solana- +[docs.rs]: https://docs.rs/releases/search?query=solana- + +Some important crates: + +- [`solana-program`] — Imported by programs running on Solana, compiled + to BPF. This crate contains many fundamental data types and is re-exported from + [`solana-sdk`], which cannot be imported from a Solana program. + +- [`solana-sdk`] — The basic off-chain SDK, it re-exports + [`solana-program`] and adds more APIs on top of that. Most Solana programs + that do not run on-chain will import this. + +- [`solana-client`] — For interacting with a Solana node via the + [JSON RPC API](jsonrpc-api). + +- [`solana-clap-utils`] — Routines for setting up a CLI, using [`clap`], + as used by the main Solana CLI. + +[`solana-program`]: https://docs.rs/solana-program +[`solana-sdk`]: https://docs.rs/solana-sdk +[`solana-client`]: https://docs.rs/solana-client +[`solana-clap-utils`]: https://docs.rs/solana-clap-utils +[`clap`]: https://docs.rs/clap