Documentation site for Amplify Security, built with
Mintlify. Configuration lives in docs.json.
The site has two tabs. Amplify Console is the current product, organized into three ideas that build on each other:
| Group | Covers |
|---|---|
Get Started |
Introduction, quickstart, CLI installation |
Agents & detections (agents/) |
The authorable primitives — agents, skills, detections — and the tool surface |
Data & connections (data/) |
Projects, connections, vendor data, findings |
Working interactively (interactive/) |
Chat and the CLI |
Workflows (workflows/) |
Creating, triggering, running, and delivering workflow results |
Amplify Dashboard (Legacy) (legacy/) documents the previous product and is not actively developed.
Install the Mintlify CLI:
npm i -g mintRun the dev server from the repository root (the directory containing docs.json):
mint devIt serves on port 3000 by default. Use --port if that's taken:
mint dev --port 3333- Create the
.mdxfile in the appropriate directory, withtitleanddescriptionfrontmatter. - Register its path (without the
.mdx) in the correct group indocs.json. A page not listed indocs.jsonwill not appear in the navigation. - If you move or rename a page, add a
redirectsentry indocs.jsonso existing links keep working.
- Frontmatter requires
titleanddescription. - Mintlify components in use:
<Note>,<Tip>,<Warning>,<CardGroup>,<Card>. - Internal links are root-relative and omit the extension —
/agents/writing-an-agent. - Document what ships today. Where a capability is partial, say so explicitly in a
<Warning>or<Note>rather than describing the intended end state.
The Mintlify GitHub App deploys automatically on push to the default branch.
- 404 on every page — you're not in the directory containing
docs.json. - A new page isn't in the sidebar — it isn't registered in
docs.json. mintnot found — install withnpm i -g mint. Note the CLI ismint, not the oldermintlifypackage, and configuration isdocs.json, not the oldermint.json.