Skip to content

Add context7.json so Context7 indexes the docs site correctly - #62

Merged
flybayer merged 2 commits into
mainfrom
devin/1787258337-context7-config
Aug 20, 2026
Merged

Add context7.json so Context7 indexes the docs site correctly#62
flybayer merged 2 commits into
mainfrom
devin/1787258337-context7-config

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a context7.json at 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: folders is intentionally omitted (whole-repo scan) rather than listing doc directories. Context7 only guarantees that root-level markdown is always included when folders is 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 a folders allowlist 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.

excludeFolders covers 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). excludeFiles is README.md (contributor build instructions) and AGENTS.md (internal authoring instructions). Note that specifying these fields replaces Context7's defaults — deliberate here, since changelog.mdx is default-excluded by Context7 but is legitimate public product documentation.

rules are four short conventions an agent should follow when writing Ravion config (project config file, --dry-run before ravion project config apply, prefer rvn- standard library modules + moduleGivenIdRef, secrets via valueFrom).

No product docs or navigation changed.

Validation: context7.json validates clean against https://context7.com/schema/context7.json (Draft-07, additionalProperties: false) with all field length limits respected; every configured path exists in the repo except node_modules (gitignored, created by pnpm install); pnpm validate, check:og-images, check:docs-seo, and node --test scripts/*.test.mjs all 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.

  • Configures Ravion’s Context7 project metadata.
  • Preserves root-level and nested product documentation, including the public changelog.
  • Supplies concise conventions for project configuration, dry runs, module references, and secret references.

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

Filename Overview
context7.json Adds a valid, deliberate Context7 indexing configuration; no actionable defect was established.

Reviews (1): Last reviewed commit: "Add context7.json for documentation inde..." | Re-trigger Greptile

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@mintlify

mintlify Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Ravion 🟢 Ready View Preview Aug 20, 2026, 8:39 PM

Co-Authored-By: bot_apk <apk@cognition.ai>
@flybayer
flybayer merged commit 6f6386f into main Aug 20, 2026
5 checks passed
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