Skip to content

chore: simplify CLAUDE.md for agent use#1180

Open
agiannelli-auth0 wants to merge 1 commit into
mainfrom
feat/hack2026
Open

chore: simplify CLAUDE.md for agent use#1180
agiannelli-auth0 wants to merge 1 commit into
mainfrom
feat/hack2026

Conversation

@agiannelli-auth0
Copy link
Copy Markdown
Contributor

Description

Trims CLAUDE.md down to behavioral rules only and moves the full Mintlify component reference into a new WRITING_GUIDE.md.

The original CLAUDE.md had grown to ~900 lines — mostly a writing style guide and component reference that's useful for humans but burns tokens on every Claude turn without changing agent behavior. This separates the two concerns:

  • CLAUDE.md is now ~25 lines of imperative rules: layout, build commands, key conventions, and guardrails. Every line changes what Claude does.
  • WRITING_GUIDE.md captures the full Mintlify component reference, admonition usage guide, placeholder conventions, and writing principles — everything a human (or triggered skill) needs, without paying the ambient context cost.

References

Hackathon!

Testing

Checklist

  • I've read and followed CONTRIBUTING.md.
  • I've tested the site build for this change locally.
  • I've made appropriate docs updates for any code or config changes.
  • I've coordinated with the Product Docs and/or Docs Management team about non-trivial changes.

- moves writing guidance to WRITING_GUIDE
@agiannelli-auth0 agiannelli-auth0 requested review from a team as code owners May 13, 2026 20:05
@github-actions
Copy link
Copy Markdown

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.

2 participants