Authoring Documentation

All project documentation lives in the docs/ directory. The docmap CLI lets both humans and AI agents discover and read documents without leaving the terminal.

Browsing with CLI

Run commands via the project's package manager (e.g. npm run docmap --, pnpm docmap).

docmap                                          # list root docs
docmap --dir topic-a --dir topic-b/sub-topic-c  # list subdirectories
docmap --recursive                              # list everything
docmap --read doc-1.md --read topic-a/doc-2.md  # read documents (frontmatter stripped)
docmap --check                                  # validate all files

Workflow