Skip to content
RustUse

Using AI Reference

This reference summarizes the AI-readable route shapes documented in this section. Use the status column to distinguish live generated routes from planned surfaces.

Root files

Section titled “Root files”
Pattern Status Notes
/llms.txt Live Concise project-wide index for discovery and routing.
/llms-full.txt Live Larger project-wide Markdown bundle.

Facade files

Section titled “Facade files”
Pattern Status Notes
/facades/{facade}/llms.txt Live Facade-level routing through the /facades/ path.
/facades/{facade}/llms-full.txt Live Expanded facade-level context through the /facades/ path.
/{facade}/llms.txt Live Canonical short facade-level routing file.
/{facade}/llms-full.txt Live Canonical short expanded facade-level context file.

Examples:

/facades/use-math/llms.txt
/facades/use-math/llms-full.txt
/use-math/llms.txt
/use-math/llms-full.txt

Crate files

Section titled “Crate files”
Pattern Status Notes
/crates/{crate}/llms.txt Planned Focused child-crate routing and examples.
/crates/{crate}/llms-full.txt Planned Deeper crate-specific context.

Planned examples:

/crates/use-prime/llms.txt
/crates/use-prime/llms-full.txt

Rustdoc routes

Section titled “Rustdoc routes”
Pattern Status Notes
/api/workspaces/{facade}/ Live where workspace Rustdocs are generated Workspace Rustdocs entry point for a facade.
/api/workspaces/{facade}/{crate_module}/index.html Live where workspace Rustdocs are generated Rustdoc module route for a crate inside a workspace.

Examples:

/api/workspaces/use-math/
/api/workspaces/use-math/use_combinatorics/index.html

MCP resource URI patterns

Section titled “MCP resource URI patterns”
Pattern Status Notes
rustuse://catalog Planned RustUse catalog resource.
rustuse://facades Planned Facade listing resource.
rustuse://facades/{facade} Planned One facade resource.
rustuse://facades/{facade}/children Planned Child crates for one facade.
rustuse://crates Planned Crate listing resource.
rustuse://crates/{crate} Planned One crate resource.
rustuse://llms Planned Root llms.txt discovery resource.
rustuse://llms/full Planned Root llms-full.txt discovery resource.
rustuse://llms/facades/{facade} Planned Facade-level llms.txt discovery resource.
rustuse://llms/facades/{facade}/full Planned Facade-level llms-full.txt discovery resource.
rustuse://llms/crates/{crate} Planned Crate-level llms.txt discovery resource.
rustuse://llms/crates/{crate}/full Planned Crate-level llms-full.txt discovery resource.
rustuse://rustdocs/workspaces/{facade} Planned Rustdoc workspace route discovery.
rustuse://rustdocs/crates/{crate} Planned Crate Rustdoc route discovery.