The customer documentation for OpenController, published with Mintlify.
- Pages are MDX files, organized by task:
get-started,discover,govern,secure,posture,monitor,administer, andintegrations(its own tab). Navigation and settings are indocs.json. - Screenshots are in
images/, beside the section they belong to. style.cssandui.jsgive the site its look;snippets/holds the walkthrough diagrams and the framework atlas.- STYLE.md is how the pages are written. It is not published.
The site before this structure is kept on the branch archive/docs-v1.
docs.json lists the documented versions under navigation.versions; the one marked "default": true (tag
Latest) is what readers see first. Add a version only when a release changes the docs enough to matter, not for every
patch. When one does:
- Copy the pages of the current version into a folder named after it, for example
v0.108/, and point that version's entry indocs.jsonat the copies (v0.108/get-started/quickstart, …). Drop itsdefaultandtag. - Add the new version at the top of
navigation.versions, with"tag": "Latest"and"default": true, using the pages at the root, which go on changing. - Run
mint broken-links: links inside the copied pages must point into their own folder.
npm i -g mint
mint dev
Then open http://localhost:3000.
mint validate
mint broken-links
CI runs the same on every pull request.