Skip to content

Add machine-readable docs for AI agents - #28

Merged
minimaldesign merged 1 commit into
mainfrom
ai-agent-docs
Jul 20, 2026
Merged

Add machine-readable docs for AI agents#28
minimaldesign merged 1 commit into
mainfrom
ai-agent-docs

Conversation

@minimaldesign

Copy link
Copy Markdown
Owner

Makes mCSS friendly to AI coding agents:

  • /llms.txt index and /llms-full.txt (the entire docs and components reference in one markdown file), generated from the content collections at build time so they can never drift from the docs.
  • Markdown twins: every docs and components page is also served at the same URL with .md appended (/docs/tokens.md, /components/card.md). MDX imports, comments, and prose wrappers are stripped; code fences are left untouched.
  • New "AI Agents" docs page with a ready-to-paste rules block for consumers' CLAUDE.md / AGENTS.md, framed around the copy-it-you-own-it philosophy.
  • rel="alternate" type="text/markdown" links on docs and components pages so tooling can discover the twins.
  • Docs pages gained optional description frontmatter, used by llms.txt and now also by meta descriptions (docs layouts pass frontmatter through to BaseLayout).
  • Removed unused npm publish fields from package.json (mCSS is not a registry package).

Verified against a production build: all endpoints return clean markdown, sidebar shows the new page, no console errors.

🤖 Generated with Claude Code

- /llms.txt index and /llms-full.txt (full reference in one file),
  generated from the content collections at build time
- Markdown twin of every docs and components page at the same URL
  with .md appended (e.g. /docs/tokens.md), with MDX noise stripped
- New "AI Agents" docs page with a ready-to-paste rules block for
  CLAUDE.md / AGENTS.md, added to the docs sidebar
- Optional description frontmatter on docs pages, surfaced in
  llms.txt and in meta descriptions (docs layouts now pass
  frontmatter through to BaseLayout)
- rel="alternate" type="text/markdown" link on docs and components
  pages pointing at their markdown twin
- Remove unused npm publish fields from package.json: mCSS is
  copy-it-you-own-it, not a registry package

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploy Preview for mcssdev ready!

Name Link
🔨 Latest commit 636112f
🔍 Latest deploy log https://app.netlify.com/projects/mcssdev/deploys/6a5db0f38a3c570008c4ca0b
😎 Deploy Preview https://deploy-preview-28--mcssdev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98
Accessibility: 96
Best Practices: 100
SEO: 99
PWA: 70
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@minimaldesign
minimaldesign merged commit 3d7c072 into main Jul 20, 2026
4 of 5 checks passed
@minimaldesign
minimaldesign deleted the ai-agent-docs branch July 20, 2026 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant