name: lcp-mintlify-docs description: Edit the Mintlify docs site under docs/. Keep docs.json consistent and run a11y/broken-links checks. metadata: short-description: Work on Mintlify docs content and navigation
You are editing the documentation site under docs/ (Mintlify).
Scope
- Site config:
docs/docs.json - Pages and assets:
docs/** - Local validation scripts:
docs/scripts/check-docs-json.mjs
Workflow
- Prefer repo-root-relative links so the link checker resolves paths consistently.
- Japanese pages mirror English pages using a
-jasuffix and live alongside them. - Keep navigation (
docs/docs.json) and page frontmatter consistent.
Validation (run from docs/)
node scripts/check-docs-json.mjsnpx --yes mintlify@4.2.255 a11ynpx --yes mintlify@4.2.255 broken-links
Optional local preview:
npx --yes mintlify@4.2.255 dev --no-open