Add CLAUDE.md with repo guidance for AI assistants - #1
Draft
quicksilverj2 wants to merge 1 commit into
Draft
Conversation
Documents the Mintlify docs site structure, MDX/frontmatter conventions, docs.json registration requirement, link style, and the boundary that this repo holds documentation only (not the PrivateInvest app source).
|
Looks good |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
CLAUDE.mdat the repo root documenting how AI assistants should work in this Mintlify documentation site.Key points covered:
docs.json+index.mdx+agent/,backend/,frontend/subdirectories.title+description), Mintlify components (<Card>,<Columns>), absolute extension-less internal links (e.g./backend/setup) — matching the fix ina378ae5.navigation.tabs[].groups[].pagesor they won't appear in the sidebar.ADMIN/COMPLIANCE/IFA/DEAL_ORIGINATOR), ports (4000/4001/4002), and stack details.quicksilverj2/docs.6c45942.Test plan
docs.jsonor any.mdxwas changed (this PR adds a single new file).Generated by Claude Code