Expand description
Generate stage: project an IndexedWorkspace into LLM-facing
artifacts.
The Preset::Publish set produces five artifact families:
llms.txt(top-level index, llmstxt.org)<crate>/index.md(narrative for each crate root)<crate>/<module>.md(narrative + public-item reference per module)llms-full.txt(all markdown concatenated, chunk-delimited)api/<crate>.json(deterministic public-API surface)
Each artifact has its own render function; render_all wires them
together and returns a deterministic list of (relative_path, body)
pairs the caller can write to disk (or diff against a checked-in
tree in --check mode). The generate stage never touches the
filesystem itself.
Structs§
- Artifact
- One generated artifact ready to be written to disk.
- Public
Module - A public module surfaced under a crate root.
Enums§
- Artifact
Location - Which base directory an
Artifact’s path is relative to.
Functions§
- render_
all - Render every artifact in the Preset::Publish set for a workspace.
- render_
api_ json - Render the deterministic public-API surface JSON for a single crate.
- render_
context7_ manifest - Render a Context7 manifest (
context7.json) for a workspace. - render_
crate_ index - Render the per-crate
index.mdnarrative document. - render_
deepwiki_ manifest - Render a DeepWiki manifest (
.devin/wiki.json) for a workspace. - render_
error_ catalog - Append the error-catalog artifact set to
artifactsin place. - render_
llms_ full - Render
llms-full.txt: every markdown artifact concatenated, with a short header before each chunk so the reader can identify boundaries. - render_
llms_ txt - Render the top-level
llms.txtindex for a workspace. - render_
module - Render the per-module narrative document.