@docspack/docspack

Documentation for docspack itself, packaged with docspack.

Website · Documentation · GitHub · Releases

Looking for the tool? Install docspack. This package is its manual, in the format docspack itself consumes.

Overview

This is docspack's documentation shipped as a documentation package — which makes it both the manual and the worked example of what one looks like. The Markdown in docs/ is the source; docspack build turns it into the .llms/ payload that docspack sync indexes.

Installing it means your agent can answer questions about docspack the same way it answers questions about any other dependency: locally, offline, and from the version you installed.

Installation

npm  install -D @docspack/docspack
pnpm add     -D @docspack/docspack

Quick start

pnpm add -D @docspack/docspack
npx docspack sync
npx docspack ask "how do I connect an agent"

Or let the agent ask, once the AGENTS.md line is in place — it will answer from these files.

What is in it

| Page | Covers | | --- | --- | | Overview | What docspack is and the problem it solves | | Installing and syncing | Requirements, install, docspack sync | | Connecting an agent | The command line and MCP, and when to prefer each | | Searching | docspack search from the terminal | | Authoring a package | init, build, doctor, preview | | Trust and safety | Vendor vs community packages, path handling | | How it compares | Docs sites, fetching MCP servers, agent skills, vector stores | | Writing for agents | What belongs in a docs package, and what doctor enforces |

The same pages are on the web at https://docspack.dev/llms.txt, and as plain Markdown at https://docspack.dev/docs/<slug>.md.

Working on it locally

pnpm turbo build --filter @docspack/docspack   # regenerate .llms/ from docs/
pnpm turbo test  --filter @docspack/docspack   # validate the generated package

.llms/ and llms.txt are generated and are not committed. The tests build nothing themselves: they read whatever the last build produced, validate it against the package specification, index it into a temporary store and check that the documentation is retrievable.

Related packages

| Package | Description | | --- | --- | | docspack | The CLI and MCP server: build, sync, search and ask. | | @docspack/registry | Curated llms.txt sources for bootstrapping docs packages. |

License

MIT — see LICENSE.