User Guide
Publish Docs at Your Own Subdomain
SystemDox turns the markdown already in your repositories into a fast, searchable documentation site at {workspace}.systemdox.com — one site for every repository and git organisation your workspace owns.
How It Works
From Markdown to Live Site
Publishing is a four-step pipeline. You click once; SystemDox does the rest.
1. Connect a repository
Install the SystemDox GitHub App and connect the repositories you want to publish — from any git organisation your workspace has access to.
2. Configure publish settings
Pick an optional URL slug (e.g. platform instead of acme/platform-service), a root directory to publish from, and whether pushes should auto-publish.
3. Publish
SystemDox fetches your markdown, builds a polished static site — sidebar navigation, dark mode, code highlighting, edit-on-GitHub links — and deploys it to a global CDN. Publishes are incremental: unchanged pages aren't rebuilt.
4. Served at your subdomain
Each repo's docs go live at {workspace}.systemdox.com/{slug}/. HTTPS, CDN caching, and real 404 pages are handled for you.
Your Subdomain Is Your Workspace, Not a Git Org
The subdomain is your workspace slug — chosen when you create the workspace, changeable in workspace settings. It is never tied to a GitHub organisation name, and one workspace can publish repositories from as many git organisations as it owns: they all appear under the same subdomain.
acme.document.systemdox.com/platform/ ← from github.com/acme-eng/platform-service
acme.document.systemdox.com/handbook/ ← from github.com/acme-ops/handbook
acme.document.systemdox.com/api-docs/ ← from github.com/acme-labs/public-api
Within the site, each repo's path defaults to {owner}/{repo} — set a URL slug in the repo's publish settings to get the short, org-free paths shown above.
One Landing Page for Everything You Publish
The root of your docs site — https://{workspace}.document.systemdox.com/ — is a landing page listing every published repository in your workspace, spanning all your git organisations: title, source repository, page count, and last-updated date, each linking straight into its docs.
Always current, zero maintenance. The landing page regenerates automatically on every publish — publish a new repo and it appears; republish an existing one and its metadata updates. There is nothing to edit by hand.
Search Across Every Repository
The landing page's search box queries a semantic search index scoped to your workspace. Every page is embedded at publish time, so results rank by meaning — not just keywords — and span all repositories and git organisations you've published, in one result list.
Semantic — finds "how do we scale?" in a page titled "Architecting to scale"
Workspace-wide — one query covers every published repo and org
Fresh — the index updates as part of every publish
Each published site also ships its own in-site search for quick lookups within a single repo's docs.
FAQ
Common Questions
What gets published from my repository?
docs/). Directory structure becomes sidebar navigation; GitHub-style alerts, code blocks, and relative images all render correctly.
Do docs update automatically when I push?
Can I change where a repo's docs appear?
/{slug}/ instead of /{owner}/{repo}/. Slugs are unique across SystemDox, so your URLs stay stable even if the repo moves between git organisations.
Do old /docs/ links still work?
/docs/…; those deep links now redirect permanently (301) to the same page at the root, so existing bookmarks and inbound links keep working.
Who can see my published docs?
Ready to Transform Your Documentation?
Start capturing architecture decisions, meeting notes, and technical designs with your voice.