tronz Docs

Documentation for tronz, an idiomatic, async-first Rust SDK for the TRON network, inspired by alloy.

View the documentation at throgxyz.github.io/docs.

The site is built with Vocs.

Development

Clone the repository with its examples submodule:

git clone --recurse-submodules https://github.com/throgxyz/docs.git
cd docs

For an existing clone:

git submodule update --init

Install dependencies and start the development server:

cd vocs
npm install
npm run dev

Vocs 2 and Waku currently require an LTS version of Node.js, preferably Node 20 or 22. Newer unsupported versions may fail during static generation.

Documentation

Hand-written documentation lives in:

vocs/docs/pages/

The main site configuration and navigation are defined in:

vocs/vocs.config.ts
vocs/sidebar.ts

To suggest a documentation change, edit the relevant hand-written page and open a pull request.

Examples

Runnable examples come from the throgxyz/examples repository, included as the lib/examples git submodule.

Refresh generated example pages with:

./scripts/update.sh

The update script:

1. Syncs the examples submodule.
2. Copies example sources into vocs/docs/snippets/.
3. Generates pages under vocs/docs/pages/examples/.
4. Regenerates vocs/example-items.ts.

Edit category descriptions and ordering in:

vocs/docs/pages/templates/<category>/README.mdx

Do not edit these generated files directly:

vocs/docs/pages/examples/
vocs/docs/snippets/
vocs/example-items.ts

Contributing

Contributions are welcome. Please open an issue or pull request in this repository for documentation changes.

For SDK changes, use the tronz repository.

License

Licensed under either the Apache License, Version 2.0 or the MIT License, at your option.