Docs
Register, edit, publish
In-app Help is the operator source of truth after install. This page is the first loop so you know the shape before you open the UI.
Start here
Three steps on a new host
- 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.
Topics
What the in-app Help covers
Prepare the product roadmap
Select Roadmap to write in docs/roadmap. For each milestone, document the goal, scope, dependencies, and acceptance criteria. Review and publish a Merge Request labelled docs:roadmap for your AI agent workflow.
Register project repositories
A registered project repository must have an origin remote. SpecDox reads and writes docs/kb, docs/internal, and docs/roadmap only.
Public, internal, and roadmap
The header switch sets the whole surface. Accent is public. Amber is internal. The badge and editor border match.
Titles, drafts, and order
Page titles, publication state, and menu order live in the sidecar next to manifest.json. Drafts stay on disk.
Publishing
Review shows the pending changes. Creating the Merge Request branches from HEAD, pushes documentation only, and labels the request.
GitLab token
Set GitLabToken in the env file as the remote host, a space, then the token used to open Merge Requests.
Install and run
Install specdox from APT, edit /etc/specdox/specdox.env, then start the service or run the binary as the operator who owns the checkouts.