Skip to content

supdoc v0.1.0

Choose a tag to compare

@aidenzepp aidenzepp released this 05 Nov 17:27
· 386 commits to main since this release

supdoc v0.1.0 is the first release. supdoc tracks links from documentation to code, such as [text](src/lib.rs#symbol), and reports when the code behind a link changes.

What it does

  • Link docs or code comments to code with ordinary Markdown links: [add](src/lib.rs#add) links one symbol, [lib](src/lib.rs) a whole file.
  • supdoc update --yes records a hash of every linked target in supdoc.lock. supdoc check compares the code with those hashes and fails when a linked target changed, so it works as a CI gate.
  • Links are read in Rust, TypeScript, JavaScript, Python, Go, Bash and Markdown files. Markdown headings are symbols too.

Commands

check, update, fix (repairs broken links whose fix is certain), list, resolve, init, config show, namespace list and namespace rename, schema, completions and skill install (supdoc's agent skill). Every command has --json output with a published JSON Schema.

Configuration

supdoc works without a config. supdoc init writes a supdoc.config.toml with every key commented out. Namespaces give a part of the project a short name, so auth:src/session.rs#login works from any file.

This GitHub release was added after the tag; the tag and the crate are unchanged.