docs: comprehensive Rust SDK documentation by gregnazario · Pull Request #383 · aptos-labs/aptos-docs

gregnazario · 2026-02-27T19:39:26Z

Summary

Replace single-page Rust SDK doc (pointing to deprecated aptos-core SDK) with 13 in-depth pages covering the new aptos-rust-sdk
Add full Spanish and Chinese translations (26 pages)
Update sidebar configuration and navigation labels

Documentation Pages

Page	Description
Overview	Installation, feature flags, quick example, legacy SDK note
Quickstart	Step-by-step: create project, fund accounts, transfer APT
Account Management	Ed25519/Secp256k1/Secp256r1, mnemonics, AnyAccount
Multi-Sig & Keyless	MultiEd25519, MultiKey, KeylessAccount
Fetch Data	Balances, account info, view functions, indexer
Building Transactions	Convenience methods, Move arg helpers, step-by-step flow
Simulating Transactions	simulate(), gas estimation, pre-flight checks
Multi-Agent Transactions	Multiple signer transactions
Sponsoring Transactions	Fee payer pattern
Batching Transactions	Batch submission
Script Transactions	Move scripts vs entry functions
Smart Contracts	Entry functions, view functions, deploy, macros, NFTs
Examples	Categorized list of all 23 SDK examples

Files Changed

39 new MDX files (13 EN + 13 ES + 13 ZH)
2 deleted MDX files (old flat Rust SDK pages for EN and ES)
4 modified config files (sidebar, nav labels for EN/ES/ZH, SDKs overview card)

Test plan

pnpm lint passes
pnpm format / pnpm format:content pass
All 39 MDX files have valid frontmatter
Build failure is pre-existing (experimental.fonts config error on main)
Visual review of rendered pages on deploy preview
Verify sidebar navigation structure renders correctly
Verify internal links resolve across all three languages

vercel · 2026-02-27T19:39:31Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
aptos-docs	Ready	Preview, Comment	Mar 2, 2026 3:22pm

Copilot

Pull request overview

This PR replaces the legacy, single-page Rust SDK documentation (pointing to the deprecated aptos-core SDK) with a new multi-page documentation set for aptos-rust-sdk, including updated sidebar navigation and localized nav labels.

Changes:

Adds new Rust SDK docs pages (EN/ES/ZH) covering quickstart, accounts, transaction building patterns, data fetching, smart contracts, and examples.
Updates sidebar structure to group Rust SDK pages under “Accounts” and “Building Transactions”.
Updates SDKs overview card copy and adds new nav label keys for Rust SDK sub-groups.

Reviewed changes

Copilot reviewed 46 out of 46 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`astro.sidebar.ts`	Adds grouped Rust SDK navigation with Accounts + Building Transactions sub-groups.
`src/content/nav/en.ts`	Adds label keys for Rust SDK sub-groups used by the new sidebar structure.
`src/content/nav/es.ts`	Adds label keys for Rust SDK sub-groups used by the new sidebar structure.
`src/content/nav/zh.ts`	Adds label keys for Rust SDK sub-groups used by the new sidebar structure.
`src/content/docs/build/sdks.mdx`	Updates the Rust SDK LinkCard description.
`src/content/docs/build/sdks/rust-sdk/index.mdx`	New EN Rust SDK landing page and requirements section.
`src/content/docs/es/build/sdks/rust-sdk/index.mdx`	New ES Rust SDK landing page and requirements section.
`src/content/docs/zh/build/sdks/rust-sdk/index.mdx`	New ZH Rust SDK landing page and requirements section.
`src/content/docs/build/sdks/rust-sdk/fetch-data-via-sdk.mdx`	New EN page describing common read/query patterns (balances, views, ledger info, etc.).
`src/content/docs/es/build/sdks/rust-sdk/fetch-data-via-sdk.mdx`	New ES version of fetch-data-via-sdk page.
`src/content/docs/zh/build/sdks/rust-sdk/fetch-data-via-sdk.mdx`	New ZH version of fetch-data-via-sdk page.
`src/content/docs/build/sdks/rust-sdk/building-transactions.mdx`	New EN “Building Transactions” guide covering end-to-end transaction flow and helpers.
`src/content/docs/es/build/sdks/rust-sdk/building-transactions.mdx`	New ES version of “Building Transactions”.
`src/content/docs/zh/build/sdks/rust-sdk/building-transactions.mdx`	New ZH version of “Building Transactions”.
`src/content/docs/build/sdks/rust-sdk.mdx`	Deletes legacy EN single-page Rust SDK doc that referenced `aptos-core`.
`src/content/docs/es/build/sdks/rust-sdk.mdx`	Deletes legacy ES single-page Rust SDK doc that referenced `aptos-core`.
`src/content/docs/build/sdks/rust-sdk/quickstart.mdx`	New EN quickstart page (account creation, faucet funding, transfer).
`src/content/docs/es/build/sdks/rust-sdk/quickstart.mdx`	New ES quickstart page.
`src/content/docs/zh/build/sdks/rust-sdk/quickstart.mdx`	New ZH quickstart page.
`src/content/docs/build/sdks/rust-sdk/rust-examples.mdx`	New EN examples index page.
`src/content/docs/es/build/sdks/rust-sdk/rust-examples.mdx`	New ES examples index page.
`src/content/docs/zh/build/sdks/rust-sdk/rust-examples.mdx`	New ZH examples index page.
`src/content/docs/build/sdks/rust-sdk/smart-contracts.mdx`	New EN smart contracts page.
`src/content/docs/es/build/sdks/rust-sdk/smart-contracts.mdx`	New ES smart contracts page.
`src/content/docs/zh/build/sdks/rust-sdk/smart-contracts.mdx`	New ZH smart contracts page.
`src/content/docs/build/sdks/rust-sdk/account.mdx`	New EN account management page.
`src/content/docs/es/build/sdks/rust-sdk/account.mdx`	New ES account management page.
`src/content/docs/zh/build/sdks/rust-sdk/account.mdx`	New ZH account management page.
`src/content/docs/build/sdks/rust-sdk/account/multi-sig-accounts.mdx`	New EN multi-sig + keyless page.
`src/content/docs/es/build/sdks/rust-sdk/account/multi-sig-accounts.mdx`	New ES multi-sig + keyless page.
`src/content/docs/zh/build/sdks/rust-sdk/account/multi-sig-accounts.mdx`	New ZH multi-sig + keyless page.
`src/content/docs/build/sdks/rust-sdk/building-transactions/*`	New EN subpages for simulation, multi-agent, sponsoring, batching, scripts.
`src/content/docs/es/build/sdks/rust-sdk/building-transactions/*`	New ES subpages for simulation, multi-agent, sponsoring, batching, scripts.
`src/content/docs/zh/build/sdks/rust-sdk/building-transactions/*`	New ZH subpages for simulation, multi-agent, sponsoring, batching, scripts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-27T19:45:06Z

src/content/docs/es/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+    ],
+};
+
+let gas_estimate = aptos.estimate_gas(payload).await?;


This example calls aptos.estimate_gas(payload) with a single argument, but the simulating-transactions docs in this same Rust SDK section use aptos.estimate_gas(&alice, payload.clone()). One of these signatures is likely wrong; please align this snippet with the actual SDK API (and keep it consistent across pages) so readers can copy/paste without compile errors.

Suggested change

let gas_estimate = aptos.estimate_gas(payload).await?;

let gas_estimate = aptos.estimate_gas(&alice, payload.clone()).await?;

Copilot · 2026-02-27T19:45:07Z

src/content/docs/zh/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+        serde_json::json!("1000"),
+    ],
+};
+
+let gas_estimate = aptos.estimate_gas(payload).await?;


This example calls aptos.estimate_gas(payload) with a single argument, but the simulating-transactions docs in this same Rust SDK section use aptos.estimate_gas(&alice, payload.clone()). One of these signatures is likely wrong; please align this snippet with the actual SDK API (and keep it consistent across pages) so readers can copy/paste without compile errors.

Copilot · 2026-02-27T19:45:07Z

src/content/docs/zh/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+// Retrieve all modules published under an account
+let modules = aptos.fullnode().get_account_modules(address).await?;
+for module in &modules {
+    println!("Module: {}", module.abi.as_ref().unwrap().name);
+}


get_account_modules is iterated as for module in &modules, but other snippets in this PR treat the response as having a .data field (e.g., for module in &modules.data). Please make these examples consistent with the actual response type so the snippet compiles as written.

Copilot · 2026-02-27T19:45:07Z

src/content/docs/es/build/sdks/rust-sdk/building-transactions.mdx

+     Usa `TransactionBuilder` para ensamblar una `RawTransaction` con el remitente, numero de secuencia, payload, ID de cadena y parametros de gas opcionales.
+
+     ```rust
+     use aptos_sdk::transaction::TransactionBuilder;


This page imports TransactionBuilder from aptos_sdk::transaction::TransactionBuilder, but other Rust SDK docs in this PR consistently use aptos_sdk::transaction_builder::TransactionBuilder. Unless the SDK re-exports it under transaction, this snippet won’t compile as written—please align the import/module path with the rest of the docs (and the actual SDK API).

Suggested change

use aptos_sdk::transaction::TransactionBuilder;

use aptos_sdk::transaction_builder::TransactionBuilder;

Copilot · 2026-02-27T19:45:07Z

src/content/docs/es/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+
+// Retrieve all modules published under an account
+let modules = aptos.fullnode().get_account_modules(address).await?;
+for module in &modules {


get_account_modules is iterated as for module in &modules, but other snippets in this PR treat the response as having a .data field (e.g., for module in &modules.data). Please make these examples consistent with the actual response type so the snippet compiles as written.

Suggested change

for module in &modules {

for module in &modules.data {

Copilot · 2026-02-27T19:45:08Z

src/content/docs/build/sdks/rust-sdk/building-transactions.mdx

+     Use `TransactionBuilder` to assemble a `RawTransaction` with the sender, sequence number, payload, chain ID, and optional gas parameters.
+
+     ```rust
+     use aptos_sdk::transaction::TransactionBuilder;


This page imports TransactionBuilder from aptos_sdk::transaction::TransactionBuilder, but other Rust SDK docs in this PR consistently use aptos_sdk::transaction_builder::TransactionBuilder. Unless the SDK re-exports it under transaction, this snippet won’t compile as written—please align the import/module path with the rest of the docs (and the actual SDK API).

Suggested change

use aptos_sdk::transaction::TransactionBuilder;

use aptos_sdk::transaction_builder::TransactionBuilder;

Copilot · 2026-02-27T19:45:08Z

src/content/docs/zh/build/sdks/rust-sdk/building-transactions.mdx

+     ```rust
+     use aptos_sdk::transaction::TransactionBuilder;
+
+     let chain_id = aptos.chain_id().await?;
+     let sequence_number = aptos.get_sequence_number(sender.address()).await?;


This page imports TransactionBuilder from aptos_sdk::transaction::TransactionBuilder, but other Rust SDK docs in this PR consistently use aptos_sdk::transaction_builder::TransactionBuilder. Unless the SDK re-exports it under transaction, this snippet won’t compile as written—please align the import/module path with the rest of the docs (and the actual SDK API).

Copilot · 2026-02-27T19:45:08Z

src/content/docs/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+    ],
+};
+
+let gas_estimate = aptos.estimate_gas(payload).await?;


This example calls aptos.estimate_gas(payload) with a single argument, but the simulating-transactions docs in this same Rust SDK section use aptos.estimate_gas(&alice, payload.clone()). One of these signatures is likely wrong; please align this snippet with the actual SDK API (and keep it consistent across pages) so readers can copy/paste without compile errors.

Suggested change

let gas_estimate = aptos.estimate_gas(payload).await?;

let gas_estimate = aptos.estimate_gas(&alice, payload.clone()).await?;

Copilot · 2026-02-27T19:45:09Z

src/content/docs/build/sdks/rust-sdk/fetch-data-via-sdk.mdx

+
+// Retrieve all modules published under an account
+let modules = aptos.fullnode().get_account_modules(address).await?;
+for module in &modules {


get_account_modules is iterated as for module in &modules, but other snippets in this PR treat the response as having a .data field (e.g., for module in &modules.data). Please make these examples consistent with the actual response type so the snippet compiles as written.

Suggested change

for module in &modules {

for module in &modules.data {

Add collapsible Rust SDK group to sidebar with sub-sections for accounts and building transactions. Add corresponding navigation labels in English, Spanish, and Chinese.

Replace the single-page Rust SDK doc (pointing to deprecated aptos-core SDK) with 13 in-depth pages covering the new aptos-rust-sdk: overview with feature flags, quickstart, account management, multi-sig/keyless accounts, fetching data, building transactions (with sub-pages for simulation, multi-agent, sponsored, batching, and script transactions), smart contracts, and examples. Includes full Spanish and Chinese translations (26 additional pages). Note: --no-verify used because the nano-staged remark hook is broken (it passes the glob AND staged files to remark --output, causing "Cannot write multiple files to single output" for any MDX commit). Content was verified with pnpm format:content and pnpm lint.

- Move MultiKeyAccount to top as the recommended approach - Demote MultiEd25519Account to legacy/compatibility section - Remove keyless accounts section (doesn't belong on multi-sig page) - Update Spanish and Chinese translations accordingly

Copilot AI review requested due to automatic review settings February 27, 2026 19:39

Copilot started reviewing on behalf of gregnazario February 27, 2026 19:39 View session

vercel bot deployed to Preview February 27, 2026 19:43 View deployment

Copilot AI reviewed Feb 27, 2026

View reviewed changes

gregnazario added 2 commits February 27, 2026 14:53

docs: update sidebar config and nav labels for Rust SDK

8506160

Add collapsible Rust SDK group to sidebar with sub-sections for accounts and building transactions. Add corresponding navigation labels in English, Spanish, and Chinese.

gregnazario force-pushed the document-rust-sdk branch from 2e97a61 to dc6c58a Compare February 27, 2026 19:53

vercel bot deployed to Preview February 27, 2026 19:58 View deployment

vercel bot deployed to Preview February 27, 2026 23:25 View deployment

Fix some code in the rust SDK

80b3b4a

vercel bot deployed to Preview March 2, 2026 15:22 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: comprehensive Rust SDK documentation#383

docs: comprehensive Rust SDK documentation#383
gregnazario wants to merge 4 commits intomainfrom
document-rust-sdk

gregnazario commented Feb 27, 2026

Uh oh!

vercel bot commented Feb 27, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Copilot AI Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	let gas_estimate = aptos.estimate_gas(payload).await?;
	let gas_estimate = aptos.estimate_gas(&alice, payload.clone()).await?;

	use aptos_sdk::transaction::TransactionBuilder;
	use aptos_sdk::transaction_builder::TransactionBuilder;

Conversation

gregnazario commented Feb 27, 2026

Summary

Documentation Pages

Files Changed

Test plan

Uh oh!

vercel bot commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel bot commented Feb 27, 2026 •

edited

Loading