Features
Project repositories, Markdown, and a Merge Request.
Register project repositories. Edit public and internal documentation, and prepare a product roadmap for AI agents. Preview as a knowledge base. Publish a labelled Merge Request an agent can implement.
Trees
Public, internal, and roadmap, same shape
docs/kb
Public
Knowledge-base corpus
Operator and user documentation. The knowledge-base viewer publishes this tree. Drafts stay on disk and leave the menu.
docs/internal
Internal
Developers and agents
Project documentation for people and agents who implement the work. Same folder shape, a distinct colour in the editor.
docs/roadmap
Roadmap
Product planning for AI agents
Prepare product milestones, priorities, dependencies, and acceptance criteria in Markdown. Keep the roadmap beside the code and publish changes as specifications an AI agent can pick up.
Roadmap for AI agents
Turn product plans into implementation context
Prepare the roadmap in docs/roadmap, then hand it to your AI agent workflow through a GitLab Merge Request.
1. Define the milestone
Describe the product goal, intended outcome, and scope. Record priorities and dependencies so the agent has context for what comes next.
2. Make the work actionable
Break the milestone into requirements and acceptance criteria. Link relevant public and internal documentation to explain the expected behaviour and constraints.
3. Publish the handoff
Review the Markdown diff and publish a Merge Request labelled docs:roadmap. Your configured job or AI agent can find it and use the changed pages and diff to guide implementation.
Publish
A path from edit to Merge Request
Review shows the pending changes and the exact diff that will be attached. The branch never includes unrelated work.
- Edit
- Preview
- Review
- Merge Request
Capabilities
What ships with the operator UI
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.
Review before you publish
Review and publish shows the pending documentation changes and the exact diff that will be attached to the Merge Request.
Labels an agent can filter
Merge Requests are labelled documentation, specdox, and docs:public, docs:internal, or docs:roadmap so a follow-up job or agent can find them.
Local single-operator host
No sign-in gate. Install the Debian package, set the env file, and open the printed URL. The service user must be able to read every registered project repository.