docpack Docs
Everything you need to connect docpack to your team and your agents — with a trust badge on every page, so you always know what to rely on.
53 docs · 46 up to date · 7 draft · published 2026-10-07 01:56 PDT · build 08be9cb8da41
docpack turns a folder of Markdown into a searchable, badged site in three commands: scaffold a pack, write a page, build it.
docpack --root my-docs init "My Team"
Continue to Quickstart: your first docpack →
Getting started
New to docpack? These pages get you from nothing to a built site.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Quickstart: your first docpack docpack turns a folder of Markdown into a searchable, badged site in three commands: scaffold a pack, write a page, build it. |
✓ UP TO DATE | Jul 29, 2026 | |
| What is DocumentEverything The product in one page: version-controlled docs that render to a badged site and machine surfaces, kept true by an agent read/write loop. |
✓ UP TO DATE | Jul 22, 2026 | |
| Start a new docpack with docpack init How to run `docpack init`: scaffold a docpack.toml and docs/ tree. |
✓ UP TO DATE | Aug 5, 2026 | |
| Adopt an existing repo with docpack adopt How to run `docpack adopt`: stamp valid frontmatter onto plain Markdown a repo already has, then work the five-stage decision queue it reports. |
✓ UP TO DATE | 6 days ago | |
| Add a new doc to the pack Scaffold, link, and validate a new typed page so it appears in the built site. |
✓ UP TO DATE | Jul 29, 2026 | |
| Get beta access docpack is in a private beta: what access includes and how to ask for it. |
✓ UP TO DATE | 6 days ago |
Everyday CLI
The commands you run once docs exist: build, check, search, edit.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Build and preview the docpack site Build the docpack into the static site bundle and preview it locally. |
✓ UP TO DATE | 6 days ago | maxlisaius |
| Build the site with docpack build How to run `docpack build`: render and emit the HTML bundle plus machine surfaces to <root>/site. |
✓ UP TO DATE | Jul 22, 2026 | |
| Preview docs locally with docpack preview How to run `docpack preview`: build, serve on localhost, and open a browser (with --watch to rebuild on change). |
✓ UP TO DATE | Jul 29, 2026 | |
| Validate structure with docpack check How to run `docpack check`: structural validation: dangling links, missing refs, duplicate ids, orphans. |
✓ UP TO DATE | Jul 22, 2026 | |
| Enforce trust with docpack audit How to run `docpack audit`: the trust gate — fail when a verified page does not compute green. |
✓ UP TO DATE | Aug 1, 2026 | |
| Search the corpus with docpack search How to run `docpack search`: section-level search; every hit carries a freshness badge. |
✓ UP TO DATE | Jul 22, 2026 | |
| Get exact command bytes with docpack snippet How to run `docpack snippet`: print a code block copy-exact, filling {{VARS}}. |
✓ UP TO DATE | Jul 29, 2026 | |
| Create a doc with docpack new How to run `docpack new`: scaffold a new doc with a generated id and valid frontmatter. |
✓ UP TO DATE | Jul 29, 2026 | |
| Edit a doc in the browser with docpack edit How to run docpack edit — a localhost-only WYSIWYG editor that writes the Markdown source back losslessly, leaving everything you did not touch byte-for-byte intact. |
✓ UP TO DATE | Jul 29, 2026 | |
| Move or rename a doc with docpack mv How to run `docpack mv`: rename a doc and record a redirect. |
✓ UP TO DATE | Jul 29, 2026 | |
| Publish a built site with docpack publish How to run `docpack publish`: finalize/publish a built bundle. |
◆ DRAFT | — | |
| Inspect corpus stats with docpack stats How to run `docpack stats`: print corpus counts and health. |
✓ UP TO DATE | Jul 22, 2026 | |
| Serve a docpack over HTTP with docpack serve How to run `docpack serve`: serve a built pack over HTTP locally. |
✓ UP TO DATE | Jul 29, 2026 |
Trust and freshness
How a badge gets earned, and how to act on one that has decayed.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Record a run with docpack log How to run `docpack log`: append a run to a doc ledger, flipping its badge. |
✓ UP TO DATE | Jul 22, 2026 | |
| Find stale docs with docpack stale How to run `docpack stale`: drain the reader-flagged stale-doc queue. |
✓ UP TO DATE | Jul 29, 2026 | |
| Quarantine a doc with docpack quarantine How to run `docpack quarantine`: mark a doc do-not-use with a status_reason. |
✓ UP TO DATE | Jul 29, 2026 | |
| Find docs behind their code with docpack drift How to run `docpack drift`: list docs whose covered code changed since the doc last did. |
✓ UP TO DATE | Jul 22, 2026 | |
| Run docpack work How to run `docpack work`: the merged documentation work queue — decayed trust, unproven pages, git drift, and uncovered code, ranked. |
✓ UP TO DATE | 6 days ago | |
| Promote a doc to verified Promoting a doc to status: verified is a claim, and docpack audit is the gate that checks the claim is honest — that the page's computed badge actu... |
✓ UP TO DATE | Jul 29, 2026 | |
| Quarantine and heal a broken doc Some docs aren't just stale or failing — they're wrong at the root, and continuing to serve them (or let an agent run them) does harm. |
✓ UP TO DATE | 6 days ago | |
| Validate a docpack before you commit Three gates run in sequence before a docpack is trustworthy to commit — run them locally, in order, before every commit or PR. |
✓ UP TO DATE | yesterday |
Capture and agents
Turning a session's evidence into a runbook, and connecting an agent.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Capture a runbook with docpack capture How to run `docpack capture`: assemble an evidence journal into a draft runbook. |
✓ UP TO DATE | Jul 29, 2026 | |
| Assemble agent context with docpack context How to run docpack context — a token-budgeted map of the corpus, meant to be pasted into a CLAUDE.md so agents know the docpack exists before they search. |
✓ UP TO DATE | Jul 22, 2026 | |
| Run the MCP server with docpack mcp How to run `docpack mcp`: start the stdio MCP server exposing the four tools. |
✓ UP TO DATE | Aug 1, 2026 | |
| Connect a coding agent via MCP Coding agents talk to a pack over the Model Context Protocol: docpack mcp speaks newline-delimited JSON-RPC 2.0 on stdio and exposes exactly four tools. |
◆ DRAFT | Aug 1, 2026 |
Migrate and import
Bringing existing Markdown, HTML, Confluence, or Notion content into a corpus.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Import HTML or Confluence with docpack import How to run `docpack import`: convert HTML/Confluence/Notion exports into reviewable drafts. |
✓ UP TO DATE | 6 days ago | |
| Import: HTML, Confluence, Notion HTML→Markdown conversion so existing docs and Confluence/Notion exports enter the corpus as reviewable drafts. |
✓ UP TO DATE | 6 days ago | |
| Migrate an existing docs site Bulk migration means running docpack import once per exported page, then working the resulting drafts through review — frontmatter, links, and stat... |
✓ UP TO DATE | 6 days ago |
How it all works
The engine underneath the CLI: format, freshness, search, the editor.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| The corpus format (v0) The Markdown + YAML frontmatter format you write pages in: required and optional fields, sections and snippets, images, and the link graph docpack validates. |
✓ UP TO DATE | Jul 28, 2026 | |
| Organize the nav with [[nav]] The optional [[nav]] array-of-tables in docpack.toml: group pages into named, ordered, pinnable sections instead of the default directory-then-type grouping — schema, the id-not-path rule, and what happens to a page no group claims. |
✓ UP TO DATE | 6 days ago | |
| Freshness and badges How each page badge is computed from status, review clock, and the append-only runs ledger. |
✓ UP TO DATE | Jul 22, 2026 | |
| Variables and copy payloads The one substitution + copy-payload engine: {{VAR}} fills, exact copy bytes for snippets, and secret variables the site panel never stores. |
✓ UP TO DATE | 6 days ago | |
| Search The in-corpus search index and query used by the CLI search verb and the MCP search_docs tool. |
✓ UP TO DATE | Jul 26, 2026 | |
| The CLI The docpack CLI: every verb, its flags, and when to reach for it — the same commands the site's copy buttons and the MCP tools run under the hood. |
✓ UP TO DATE | Jul 21, 2026 | |
| The MCP server The stdio (and hosted) MCP server exposing four tools to agents: search_docs, read_page, get_snippet, and next — which answers what to do and records what you did. |
✓ UP TO DATE | Jul 29, 2026 | |
| The editor: lossless read/write docpack edit writes straight back to your Markdown source, losslessly: fences, {{variables}}, and links you didn't touch survive byte-for-byte. |
✓ UP TO DATE | Jul 29, 2026 | |
| The trust model Computed freshness/trust badges, the draft/verified/stale/quarantined lifecycle, and the audit gate that enforces them. |
✓ UP TO DATE | Jul 21, 2026 | |
| The route to green The map an agent actually walks: three planes, four MCP tools, the boundary where the machine stops, and which queue signals have no door on the machine side. |
✓ UP TO DATE | 6 days ago | |
| The dogfood loop The read/write loop: agents run a process, log what actually happened, and heal the page at the point of injury. |
✓ UP TO DATE | 6 days ago | |
| Check and audit The validation rules (links, refs, ids, orphans) and the trust gate that fails the build on a lying verified page. |
✓ UP TO DATE | Jul 28, 2026 | |
| Why docs are plain files in git Docs live as Markdown plus frontmatter in git; wikis and build services lose grep, diff, and agents. |
✓ UP TO DATE | Aug 7, 2026 |
Hosted service
Onboarding an org, minting tokens, and running the hosted control plane.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Edit a page from the website How to fix a doc from your browser, with no git and no checkout — what you click, what happens next, and why your change waits for review. |
◆ DRAFT | — | |
| Onboard an org on the hosted service Connect your org's repos to the hosted service and turn a discovered pack into a live, served space from the admin dashboard. |
◆ DRAFT | — | |
| Mint a read token for an agent Read-scoped tokens let an agent (or any non-interactive caller) read a private space via Authorization: Bearer <token> without a human session. |
◆ DRAFT | — | |
| Use an org:admin token to manage spaces from an agent or script An org:admin token lets a non-interactive caller create, rebuild and delete hosted spaces over HTTP — and by design it can tighten access but never widen it. |
◆ DRAFT | — | |
| Connect a docpack space to Claude as a custom connector Add a hosted org-mode space to Claude as a custom connector using static_headers auth — the org's existing dpk_ read token, entered once. |
◆ DRAFT | — |
Contributing to docpack
Working on the engine itself: tests, fixtures, architecture, the editor internals.
| Doc | Status | Last verified | Owner |
|---|---|---|---|
| Guides and how-tos The map of the docpack wiki: how to run the CLI verbs, the end-to-end process runbooks, and the reference pages that explain how it all works. |
✓ UP TO DATE | 6 days ago |
Badges
✓ UP TO DATE verified, and proven by a run if it makes a runnable claim
◆ NEEDS REVIEW / DRAFT unreviewed, past its review window, or hasn't earned a green run yet
■ DO NOT USE / ✗ FAILING quarantined, or its last logged run failed — don't follow it
◆ SUPERSEDED replaced by a newer doc; kept for history only