Add context7.json so Context7 indexes the docs site correctly - #62
Merged
Conversation
Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-Authored-By: bot_apk <apk@cognition.ai>
flybayer
approved these changes
Aug 20, 2026
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
context7.jsonat the repo root so Context7 (the docs-retrieval index that coding agents query) parses this repo deliberately instead of guessing, and so agents get Ravion's usage conventions alongside the docs.Key decision:
foldersis intentionally omitted (whole-repo scan) rather than listing doc directories. Context7 only guarantees that root-level markdown is always included whenfoldersis set; our entry-point pages are root-level.mdx(index.mdx,start-here.mdx,how-ravion-works.mdx,agent-skill.mdx,philosophy.mdx,changelog.mdx), so afoldersallowlist risks silently dropping getting-started content. Exclusion-only keeps every doc tree (cli/,config-as-code/,concepts/,modules/,module-definitions/,pipelines/,deploy/aws/,guides/,migrate/,troubleshooting/,mcp/,api-reference/,snippets/) indexed while removing non-documentation material.excludeFolderscovers only non-docs:node_modules(dependencies, generated at install),./scripts(sync/check tooling),./styles(Vale vocab),./fonts,./images,./logo(assets),./.agents+./.mintlify(vendored authoring/assistant skills, not product docs),./.github(CI).excludeFilesisREADME.md(contributor build instructions) andAGENTS.md(internal authoring instructions). Note that specifying these fields replaces Context7's defaults — deliberate here, sincechangelog.mdxis default-excluded by Context7 but is legitimate public product documentation.rulesare four short conventions an agent should follow when writing Ravion config (project config file,--dry-runbeforeravion project config apply, preferrvn-standard library modules +moduleGivenIdRef, secrets viavalueFrom).No product docs or navigation changed.
Validation:
context7.jsonvalidates clean againsthttps://context7.com/schema/context7.json(Draft-07,additionalProperties: false) with all field length limits respected; every configured path exists in the repo exceptnode_modules(gitignored, created bypnpm install);pnpm validate,check:og-images,check:docs-seo, andnode --test scripts/*.test.mjsall pass.Submitting/claiming the library in Context7 is a separate step outside this repo and has not been done.
Link to Devin session: https://app.devin.ai/sessions/c817e14ffa13482cbe7ae6e4bbf4286b
Greptile Summary
Adds a root-level Context7 configuration so the complete public documentation tree is indexed while repository tooling, assets, and contributor instructions are excluded.
Confidence Score: 5/5
The PR appears safe to merge with no actionable indexing, configuration, or security issue identified.
The exclusions cover the tracked non-documentation material described by the PR, the intentionally indexed changelog is public documentation, and the added conventions align with the repository’s documented workflows.
Important Files Changed
Reviews (1): Last reviewed commit: "Add context7.json for documentation inde..." | Re-trigger Greptile