Skip to content

vox-doc-pipeline API Reference (generated)

Crate: vox-doc-pipeline · Version: 0.6.0 · Target: Library (lib.rs)

Documentation linter + corpus export for docs/src (Starlight owns sidebar/RSS generation).

Documentation linter: scans docs/src/ for frontmatter, code fence, and doctest issues.

DependencyKind
vox-bounded-fsNormal
vox-compilerNormal
vox-diagramNormal
vox-kb-facetsNormal
ModuleDescription
claims—
pipeline—
Dependency Topology, diagram 18 nodes, 7 edges: vox-doc-pipeline → vox-bounded-fs; vox-doc-pipeline → vox-compiler; vox-doc-pipeline → vox-diagram; vox-doc-pipeline → vox-kb-facets; vox-cli → vox-doc-pipeline; vox-cli-ci → vox-doc-pipeline; vox-cli-research → vox-doc-pipelinevox-doc-pipelinevox-bounded-fsvox-compilervox-diagramvox-kb-facetsvox-clivox-cli-civox-cli-research
Diagram source
graph {
direction: right
node vox_doc_pipeline: "vox-doc-pipeline"
node vox_bounded_fs: "vox-bounded-fs"
vox_doc_pipeline -> vox_bounded_fs
node vox_compiler: "vox-compiler"
vox_doc_pipeline -> vox_compiler
node vox_diagram: "vox-diagram"
vox_doc_pipeline -> vox_diagram
node vox_kb_facets: "vox-kb-facets"
vox_doc_pipeline -> vox_kb_facets
node vox_cli: "vox-cli"
vox_cli -> vox_doc_pipeline
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_doc_pipeline
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_doc_pipeline
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
KindSymbolSignatureSourceDescription
fnclaims::scan_filepub fn scan_file(crates/vox-doc-pipeline/src/claims/mod.rs#L52Scan a single documentation file and resolve all extracted mentions.
fnclaims::scan_corpuspub fn scan_corpus(crates/vox-doc-pipeline/src/claims/mod.rs#L65Scan the entire documentation corpus (or filtered paths) and resolve all mentions.
fnpipeline::lint_inpub fn lint_in(root: &Path, args: &[String]) -> i32crates/vox-doc-pipeline/src/pipeline/mod.rs#L258Run the doc pipeline in-process against root, returning the process exit code the caller would have used (0 success, 1 failure) instead of calling std::process::exit directly — so it can be called from another binary’s own main (e.g. vox ci pre-push) without tearing down that process, and unit-tested without touching the real repo tree. Every path read is joined under root; this never reads the process cwd (std::env::current_dir / a bare relative Path::new("docs/src")), which matters because vox ci pre-push runs this concurrently with its own heartbeat thread and must not call std::env::set_current_dir (a process-global mutation) to point it at the repo root.
fnpipeline::runpub fn run()crates/vox-doc-pipeline/src/pipeline/mod.rs#L759-L764Run the doc pipeline: lint source markdown and optionally export corpus. SUMMARY.md and feed.xml are no longer generated here — the Starlight site builds the sidebar and RSS from frontmatter directly at Astro build time.