Reference

Hosted Rustdoc is now the primary API reference

The core library reference now has a live generated-docs destination. Use the hosted Rustdoc site for exact APIs, then fall back to workspace source or local cargo doc when you need implementation detail or pre-publish verification.

Reference entry points available now

Current reference model

Hosted Rustdoc

Use the published Rustdoc site for exact APIs, traits, module ownership boundaries, and crate-level architecture docs.

Portal guides

Use this developer portal to understand architecture, adoption paths, and how the pieces fit together in practical applications.

Workspace source

Use the repository when you want implementation detail, contribution context, or to inspect docs before the hosted site refreshes.

Publishing model

The hosted site publishes from the `gestura-app` workspace through GitHub Actions and GitHub Pages. That keeps the public API destination close to the code that owns it while letting this portal point at a live generated reference.

High-signal hosted crate entry points

Reproduce or inspect the docs locally

Use the local build when you want to validate documentation changes before the hosted site refreshes, or when you need to inspect the full workspace reference while working offline. From the `gestura-app` workspace root, run:

cargo doc --workspace --no-deps
open target/doc/gestura_core/index.html

What this unlocks next

  • • Link guide pages directly to the exact hosted crate or module they describe.
  • • Keep public API truth close to inline Rustdoc instead of hand-maintained tables.
  • • Let contributors validate docs locally and know exactly where the published site will land.
  • • Move the portal toward architecture guidance while the hosted docs own the exact API surface.
Return to quickstart Read core libraries guide