clawker
AGENTS.md59 starsChanged 12 days agoMITView on GitHub
Source: internal/docs/markdown.go (GenMarkdownTreeWebsite, EscapeMDXProse) + cmd/gen-docs/main.go (--website flag) Mintlify parses all .md/.mdx files as MDX — there is no per-file way to disable this. Bare <word> angle brackets cause JSX parse errors. The EscapeMDXProse() function escapes <word> → <word> in prose while leaving fenced code blocks untouched. Sidebar groups: Get started, Running Agents, Security, Building images, Extensions, Operations, Under the hood, Developer guide, CLI Reference (collapsible sub-groups per command family). Only top-level groups carry icons; pages never set icon: in…
In this repository17 other files it gives its agents.
- AGENTS.mdAGENTS.md
- clawkerd/AGENTS.mdAGENTS.md
- controlplane/AGENTS.mdAGENTS.md
- test/AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- agent-filesSkill
- audit-memorySkill
- cli-outputSkill
- dev-checksSkill
- firewall-uatSkill
- initiativeSkill
- monitoring-checksSkill
- store-editorSkill
- test-hunterSkill
- wizard-commandsSkill
- writing-testsSkill
- code-reviewSkill
The file
Files
Mintlify Documentation Site (docs.clawker.dev)
File Conventions
docs/docs.json— Mintlify config (theme, nav, colors, integrations). Notmint.json(legacy name)docs/index.mdx— Homepage.mode: framelanding page in the Product Guide template layout (hero, feature card, product cards, common tasks grid) with the prose sections below in.product-guide-prosedocs/*.mdx— Hand-authored pages (quickstart, installation, etc.). Exception:docs/configuration.mdxis auto-generated (fromcmd/gen-docs/configuration.mdx.tmpl+ schema struct tags — never edit directly)docs/cli-reference/*.md— Auto-generated CLI reference (never edit directly). Generated via Makefile, checked in, freshness verified in CI (coversdocs/cli-reference/anddocs/configuration.mdx)docs/architecture.mdx,docs/design.mdx,docs/testing.md— Developer docs with Mintlify frontmatterdocs/custom.css— Mintlify Product Guide templatestyle.css(sidebar anchor styling, frame-mode landing page, feature card) with amber palettedocs/favicon.svg—>_terminal prompt icon (amber#f59e0bon dark#09090b)docs/assets/— Image assets directory
Extensions
- Hand-authored pages:
.mdx - Auto-generated CLI reference:
.md - Frontmatter required on all pages (
title:minimum)
Regenerating CLI Reference
go run ./cmd/gen-docs --doc-path docs --markdown --website --schemasSource: internal/docs/markdown.go (GenMarkdownTreeWebsite, EscapeMDXProse) + cmd/gen-docs/main.go (--website flag)
MDX Parsing
Mintlify parses all .md/.mdx files as MDX — there is no per-file way to disable this. Bare <word> angle brackets cause JSX parse errors. The EscapeMDXProse() function escapes <word> → `<word>` in prose while leaving fenced code blocks untouched.
Theming
- Layout: Mintlify Product Guide template (
mintlify/templates/product-guide): themealmond, lucide icons, global sidebar anchors (Home, GitHub, Releases),navigation.directory: card, groups with icons andexpanded: true(except CLI Reference), navbar links empty with GitHub star-count button (navbar.primarymust be an external URL; it opens a new tab) - Palette (canonical, do not change): amber (
#f59e0bprimary,#fbbf24light,#d97706dark); background#09090bwith grid decoration; dark-only (appearance.strict: true) - Fonts: theme default. Do not add a
fontkey; the schema key isfontsand afontblock is ignored - Feature card on the homepage uses an amber gradient instead of the template's leaf images
- Icons:
icons.libraryislucide; use lucide names inicon=props (settings,zap,layers,boxes,box,package,shield,key,terminal)
Navigation Structure
Sidebar groups: Get started, Running Agents, Security, Building images, Extensions, Operations, Under the hood, Developer guide, CLI Reference (collapsible sub-groups per command family). Only top-level groups carry icons; pages never set icon: in frontmatter. A group's overview page uses sidebarTitle: "Overview" so the group name is not repeated (see index.mdx, security.mdx).
Navbar: GitHub star-count button only. Sidebar global anchors: Home, GitHub, Releases.
Architecture
- Generation:
--websiteflag oncmd/gen-docsproduces MDX-safe output with Mintlify frontmatter - Deployment: Mintlify-hosted, GitHub App auto-deploy on push
- Custom domain:
docs.clawker.devvia Cloudflare CNAME →cname.vercel-dns.com - Local preview:
npx mintlify dev --docs-directory docs(requires Node.js) - deepwiki MCP (
mintlify/docsrepo) is the go-to for Mintlify questions
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

