2026-07-22 01:29:32 -04:00
|
|
|
# DocForge
|
|
|
|
|
|
|
|
|
|
DocForge is a project-scoped documentation service for people and AI agents. It loads canonical
|
|
|
|
|
Markdown and TOML from one repository, validates stable nodes and relationships, builds a disposable
|
|
|
|
|
search index, and returns bounded context with source provenance.
|
|
|
|
|
|
|
|
|
|
DocForge does not own project facts. It does not select project work, edit generated output, run
|
|
|
|
|
project commands, or perform Git and deployment operations.
|
|
|
|
|
|
|
|
|
|
## Current gate
|
|
|
|
|
|
2026-07-22 02:58:51 -04:00
|
|
|
DFG-1 through DFG-3 are complete. DFG-4 is the active gate: deterministic previews and renderer
|
|
|
|
|
orchestration over validated project data. Canonical application remains external and closed to the
|
|
|
|
|
normal MCP server.
|
2026-07-22 01:29:32 -04:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
uv sync
|
|
|
|
|
uv run python -m unittest discover -s tests -v
|
|
|
|
|
uv run docforge --project-root tests/fixtures/alpha validate
|
2026-07-22 02:58:51 -04:00
|
|
|
uv run docforge-mcp --project-root tests/fixtures/alpha --proposal-writer alpha-editor
|
2026-07-22 01:29:32 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The command prints deterministic JSON. Derived indexes live under each project's configured cache
|
|
|
|
|
directory and are never canonical input.
|
2026-07-22 02:58:51 -04:00
|
|
|
|
|
|
|
|
Proposal writers are declared by ID in `.docforge/project.toml`. Each writer receives explicit node
|
|
|
|
|
families and operation types. The MCP process binds to one writer at startup; tools cannot select or
|
|
|
|
|
impersonate another writer. Create, update, move, and delete tools write only isolated JSON
|
|
|
|
|
changesets below the configured changeset root.
|
