API Reference

API docs

RustUse.org is the canonical API surface.

RustUse hosts the primary generated API docs for the currently supported crates. The curated docs stay in Starlight pages, and the generated rustdoc output stays under stable /api paths.

• Workspace Rustdocs
• Current crates

RustUse.org is the primary API documentation surface for the currently supported crates.

The current public crates remain scaffolded. Their future crates.io and docs.rs URLs are prewired in the catalog as a dry-run, but the site keeps those links disabled until the external pages exist.

Keep external registry links staged until release

Required attention

Ferris emphasizes information that directly affects correctness, compatibility, or adoption. Important callouts should be read before continuing.

Current API entry points

• use-math workspace Rustdocs
• use-combinatorics API docs
• use-math API docs
• use-geometry API docs

use-math Scaffolded

use-math

Facade crate with feature-flagged re-exports and a prelude module.

• math
• facade
• prelude

• RustUse API docs
• GitHub
• crates.io after publish
• docs.rs after publish

use-math Scaffolded

use-geometry

2D geometry primitives and common measurement helpers.

• math
• geometry
• 2d

• RustUse API docs
• GitHub
• crates.io after publish
• docs.rs after publish

use-math Scaffolded

use-combinatorics

Counting, permutations, combinations, and discrete helpers.

• math
• discrete
• counting

• RustUse API docs
• GitHub
• crates.io after publish
• docs.rs after publish

How RustUse.org relates to crates.io and docs.rs

• RustUse.org hosts the curated guides, set pages, crate overviews, and generated API docs.
• crates.io is the package registry and should point each published crate’s documentation field at the stable RustUse API URL.
• docs.rs may still build generated docs automatically after publication, but it is a fallback reference rather than the canonical destination.
• Prewire future crates.io and docs.rs URLs in the crate catalog while a crate is still scaffolded, then flip the crate status to published only after the live registry pages resolve.
• Do not scrape or mirror docs.rs HTML into this site.

Recommended Cargo.toml metadata

[package]
name = "use-geometry"
description = "Primitive geometry utilities for Rust."
repository = "https://github.com/RustUse/use-math"
homepage = "https://rustuse.org"
documentation = "https://rustuse.org/api/use-geometry"
license = "MIT OR Apache-2.0"
readme = "README.md"
keywords = ["geometry", "math", "utility"]
categories = ["mathematics"]

• Use homepage for the RustUse project site.
• Use documentation for the stable RustUse API path once it is live for a published crate.
• Use repository for GitHub.
• Keep README.md ready for the crates.io package page.
• Keep scaffolded crates on RustUse-hosted API docs until the external registry pages are confirmed live.

Future enhancement

Rustdoc JSON is a later enhancement

Early-stage idea

Ferris identifies APIs, patterns, or examples that are still being tested. Experimental callouts signal that behavior, naming, or structure may change.

• Later we can fetch docs.rs rustdoc JSON from https://docs.rs/crate/<crate-name>/latest/json for lightweight symbol indexes or generated summaries.
• Validate the rustdoc JSON format_version before parsing it in Rust or Node.
• Do not depend on rustdoc JSON for the first version of the site.
• Do not mirror full docs.rs HTML.