Skip to content
RustUse

LLM Text Files

RustUse publishes generated Markdown text files for tools that prefer a compact, AI-readable entry point. These files do not replace the docs site or Rustdocs. They help assistants route themselves to the right facade, crate, repository, and API documentation.

Root files

Section titled “Root files”
File Status Use
/llms.txt Live Concise project-wide index for discovery, routing, and project orientation.
/llms-full.txt Live Larger project-wide Markdown bundle for tools that can ingest more context.

/llms.txt is best when the assistant needs a quick map of RustUse. It includes primary links, workspace Rustdoc patterns, and generated facade links.

/llms-full.txt is best when a tool can ingest more context. It includes the broader project context plus generated facade and crate links.

Facade-level files

Section titled “Facade-level files”
File Status Use
/facades/{facade}/llms.txt Live Focused facade-level routing through the facade overview route.
/facades/{facade}/llms-full.txt Live Expanded facade-level context through the facade overview route.
/{facade}/llms.txt Live Canonical short facade-level routing file.
/{facade}/llms-full.txt Live Canonical short expanded facade-level context file.

The short facade routes and /facades/ routes are generated from the same content so they cannot drift.

Examples:

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

Use facade-level files when the task is already scoped to one RustUse facade, such as use-math, use-web, or use-python.

Crate-level files

Section titled “Crate-level files”
File Status Use
/crates/{crate}/llms.txt Planned Focused child-crate usage 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

Until crate-level files are generated, use the owning facade’s LLM text file, the crate guide page, and Rustdocs. For use-prime, start with /facades/use-math/llms.txt or /use-math/llms.txt.

Which file should I use?

Section titled “Which file should I use?”
  • Use root llms.txt for project discovery.
  • Use root llms-full.txt for broad project context.
  • Use facade-level llms.txt for focused facade work.
  • Use facade-level llms-full.txt for complete facade context.
  • Use crate-level llms.txt for focused child-crate usage once crate-level files are available.
  • Use crate-level llms-full.txt for deeper crate-specific work once crate-level files are available.

Verification path

Section titled “Verification path”

When an assistant suggests RustUse code, check the generated code against the public crate page, the workspace Rustdocs, and local tests. The LLM text files are routing and context surfaces, not an authority on final API correctness.