specdox
SpecDox
Edit specifications in Markdown. Publish them as a Merge Request an agent can implement.
For authors and agents
Write the spec. Open the Merge Request. Let the agent implement.
SpecDox aggregates project repositories, previews them as a knowledge base, and publishes a labelled Merge Request whose description carries the diff.
Prepare a roadmap for AI agents
Use docs/roadmap to describe what to build next: goals, milestones, priorities, dependencies, and acceptance criteria. Publish a labelled Merge Request with the roadmap diff so an AI agent can use your plan as implementation context.
A Merge Request the agent can pick up
Publishing opens a labelled GitLab Merge Request. The description lists every changed page and carries the specification diff, so an agent implements against the text you wrote.
Only documentation leaves the checkout
The branch stages docs/kb, docs/internal, and docs/roadmap. Unrelated work in the same repository is never included.
Live knowledge-base preview
What you see in the editor is what the knowledge base publishes. Titles, drafts, and menu order live beside the Markdown.
Public, internal, and roadmap stay distinct
A header switch sets the tree. Accent marks public. Amber marks internal. Green marks roadmap. The editor border and page badge follow the same choice.
The job
Register. Edit. Publish.
Point SpecDox at a project repository, write Markdown in public, internal, or roadmap, then open a Merge Request an agent can pick up.
- 01
Register a project repository
Point SpecDox at a project repository root that has an origin remote. Public, internal, and roadmap trees are created on first use.
- 02
Edit and preview
Write Markdown. Switch public, internal, or roadmap in the header. The knowledge-base preview follows the same tree.
- 03
Review and publish
Create a Merge Request. The description carries the specification diff. An agent can pick it up and implement it.
Publish path
Edit, preview, review, Merge Request
The branch carries only documentation. The Merge Request description lists every changed page and the specification diff.
- Edit
- Preview
- Review
- Merge Request
Why operators pick it
One host for every project repository
Public, internal, and roadmap trees follow the same standard. The knowledge-base preview matches what readers will see.
Product roadmap, ready for AI agents
A dedicated docs/roadmap tree keeps product plans separate from public and internal documentation. Write milestones and actionable requirements, review the changes, then publish with docs:roadmap so your agent workflow can find the plan.
Register project repositories
Each project repository has an origin remote. SpecDox creates the three documentation trees on first use and never invents a second layout.
Markdown with a live preview
Write pages as Markdown. Folders under content/ become menu levels at any depth. The preview uses the same renderer as the published knowledge base.
The menu writes itself
manifest.json is regenerated after every change. Titles come from the page title you set, else the first heading, else the file name. Drafts stay versioned and leave the menu.
Install the documentation host
specdox ships as a Debian package on the Aurora APT mirror. Register project repositories after you configure the env file.