Skip to content

📝 docs: add Context7 indexing configuration - #2095

Open
roninjin10 wants to merge 1 commit into
mainfrom
shepherd/tevm-monorepo-issue-2058
Open

📝 docs: add Context7 indexing configuration#2095
roninjin10 wants to merge 1 commit into
mainfrom
shepherd/tevm-monorepo-issue-2058

Conversation

@roninjin10

@roninjin10 roninjin10 commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add a root Context7 configuration that targets the Vocs product documentation in docs/node/pages
  • exclude internal root reports and contributor material, including the large review.md and fix-report.md files, so they do not degrade indexed snippets
  • add current 1.0-era guidance for the viem-compatible memory client, tevm/common, and Solidity imports

Validation

  • python3 -m json.tool context7.json
  • bunx biome check context7.json
  • validation against https://context7.com/schema/context7.json with AJV

Context7 rollout

After merging, a maintainer must submit https://github.com/evmts/tevm-monorepo at https://context7.com/add-library?tab=github to trigger the initial crawl. Adding this configuration alone does not perform that one-time submission.

After indexing, verify the result with:

curl -s 'https://context7.com/api/v1/search?query=tevm'

The response should contain an /evmts/tevm-monorepo entry with state: finalized.

Merge timing

Tevm 1.0.0 final has not shipped yet; tevm@1.0.0-rc.153 is currently the latest release candidate. Also, the latest maintainer note on #2058 says to leave the integration open but not implement it for now. This draft is intentionally framed as ready to merge if and when roninjin10 wants to trial Context7.

Closes #2058

Thanks to @PaulRBerg for the report.

Support Context7 docs for issue #2058.

Summary by CodeRabbit

  • Documentation
    • Added project configuration for documentation folders, excluded files, project metadata, usage guidance, and version tracking.

Configure Context7 to index the Vocs product documentation while excluding root-level internal reports and contributor files.

<prompt>Support Context7 docs for issue #2058.</prompt>
@changeset-bot

changeset-bot Bot commented Aug 7, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1bf49f5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
node Ready Ready Preview Aug 7, 2026 3:33am
tevm-monorepo-app Ready Ready Preview Aug 7, 2026 3:33am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
tevm-monorepo-tevm Ignored Ignored Aug 7, 2026 3:33am

Request Review

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: eb5aac9d-bb24-455b-b404-49ba05a59d9a

📥 Commits

Reviewing files that changed from the base of the PR and between 6199d04 and 1bf49f5.

📒 Files selected for processing (1)
  • context7.json

📝 Walkthrough

Walkthrough

Added context7.json with Tevm project metadata, documentation scope, excluded paths, usage rules, recommended APIs and imports, Solidity bundler guidance, and version history settings.

Changes

Context7 support

Layer / File(s) Summary
Context7 project configuration
context7.json
Adds Context7 metadata and documentation guidance for Tevm, including documentation scope, exclusions, API recommendations, Solidity bundler behavior, and an empty previous-versions list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the addition of Context7 indexing configuration.
Description check ✅ Passed The description explains the changes, validation performed, rollout steps, timing, and linked issue, despite using different section headings than the template.
Linked Issues check ✅ Passed The configuration directly supports issue #2058 by adding Context7 documentation support for LLM discovery.
Out of Scope Changes check ✅ Passed The changes remain within scope by configuring Context7 indexing and documenting related validation and rollout steps.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch shepherd/tevm-monorepo-issue-2058

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@claude

claude Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error —— View job


I'll analyze this and get back to you.

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.

Support for context7 docs

1 participant