docs: ENSv2-focused refinements#2099
Merged
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Contributor
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR reorganizes ENSNode docs by creating a /docs/reference/subgraph-legacy/ section for legacy Subgraph content, updating Starlight sidebar entries to surface REST/ENSNode V2 notes and nest legacy Subgraph links under the new path, removing duplicate Subgraph references from main pages, adding redirects for legacy routes, and updating several service/integration docs to point at the new legacy paths. ChangesReference / Legacy Subgraph reorganization
Estimated code review effort 🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
tk-o
force-pushed
the
docs/ensv2-focused-refinements
branch
from
25c56f6 to
b00cc2b
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Refines ENSv2-/subgraph-legacy-focused documentation by reorganizing legacy Subgraph content into a dedicated “Subgraph API (Legacy)” section, expanding ENSApi docs, and tightening navigation/entrypoints across self-hosting and hosted-instance pages.
Changes:
- Rehomes/introduces Subgraph legacy docs (Subgraph API, compatibility tooling, querying best practices) under
/docs/reference/subgraph-legacy/*and updates sidebar structure accordingly. - Improves service docs UX: expands ENSApi overview and adds a Docker self-host doc link to image-building guidance.
- Updates integration docs: refreshes hosted instances sectioning and plugin lists; removes outdated/WIP reference material.
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/unknown-labels.mdx | Removes a reference link that no longer matches the reorganized best-practices location. |
| docs/ensnode.io/src/content/docs/docs/services/ensapi/index.mdx | Expands ENSApi overview with GraphQL/REST sections and a REST reference LinkCard. |
| docs/ensnode.io/src/content/docs/docs/self-host/docker.mdx | Adds a LinkCard pointing to Docker image build documentation. |
| docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/what-is-the-ens-subgraph.mdx | Updates compatibility tooling link to the new subgraph-legacy path. |
| docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-compatibility-tooling.mdx | Adds a dedicated page describing transition tooling. |
| docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdx | Adds legacy Subgraph API endpoint documentation and examples. |
| docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/querying-best-practices.mdx | Adds best-practices guidance around stable identifiers, normalization, and unknown labels. |
| docs/ensnode.io/src/content/docs/docs/reference/rest-api.mdx | Removes Subgraph GraphQL content and a placeholder Registrar Actions section from REST API docs. |
| docs/ensnode.io/src/content/docs/docs/reference/indexing-ens-compatible-onchain-names.mdx | Deletes an outdated WIP reference page. |
| docs/ensnode.io/src/content/docs/docs/reference/index.mdx | Removes the Subgraph compatibility card from the Reference landing page. |
| docs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdx | Restructures hosted instances documentation; adds ENSv2 section and updates plugin lists. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/reference.ts | Reorganizes the reference sidebar to nest legacy Subgraph docs under a collapsed group. |
Comments suppressed due to low confidence (1)
docs/ensnode.io/src/content/docs/docs/reference/rest-api.mdx:14
- Grammar: “verify it's configuration” should be “verify its configuration” (possessive, not a contraction).
The Config API provides a complete view of an ENSNode instance's public
configuration, making it easy to understand and verify it's configuration.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdx`:
- Line 64: The plugins attribute value contains a missing space after a comma in
the token "ensv2,protocol-acceleration"; update the plugins attribute (the line
starting with plugins="subgraph, basenames, lineanames, registrars,
ensv2,protocol-acceleration") to insert a space after the comma so it reads
"...ensv2, protocol-acceleration" to match the other comma-space separated
lists.
In
`@docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdx`:
- Around line 12-19: The note block labeled :::note[Subgraph API Compatibility
Reference] is redundant because the inline sentence duplicates the LinkCard
title; update the note to either remove the sentence "For details on subgraph
compatibility, see the Subgraph Compatibility documentation." or replace it with
a concise explanatory line summarizing what compatibility covers (e.g.,
supported schema versions, breaking changes, migration steps), and keep the
LinkCard component (<LinkCard href=... title="Subgraph Compatibility"/>) for the
full reference link so readers get one brief informative sentence plus the link.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f50453e5-5e8d-4a18-bf63-35dfcf871178
📒 Files selected for processing (12)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/reference.tsdocs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdxdocs/ensnode.io/src/content/docs/docs/reference/index.mdxdocs/ensnode.io/src/content/docs/docs/reference/indexing-ens-compatible-onchain-names.mdxdocs/ensnode.io/src/content/docs/docs/reference/rest-api.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/querying-best-practices.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-compatibility-tooling.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/what-is-the-ens-subgraph.mdxdocs/ensnode.io/src/content/docs/docs/self-host/docker.mdxdocs/ensnode.io/src/content/docs/docs/services/ensapi/index.mdxdocs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/unknown-labels.mdx
💤 Files with no reviewable changes (4)
- docs/ensnode.io/src/content/docs/docs/reference/indexing-ens-compatible-onchain-names.mdx
- docs/ensnode.io/src/content/docs/docs/reference/index.mdx
- docs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/unknown-labels.mdx
- docs/ensnode.io/src/content/docs/docs/reference/rest-api.mdx
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
lightwalker-eth
approved these changes
May 14, 2026
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Great to see these updates! Reviewed and shared some suggestions. Please take the lead to merge this for us! 🚀
Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com> Co-authored-by: Tomek Kopacki <tomasz@kopacki.net>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdx`:
- Line 19: The sentence has a singular/plural mismatch: change the clause that
currently reads “It must include two main files” to plural to match “Plugins” —
e.g., update the sentence in the paragraph containing “Each ENSIndexer plugin is
a standalone TypeScript module…” so the phrase becomes “They must include two
main files” (or similar plural wording) to match the subject “Plugins.”
- Line 33: Update the GitHub link in the docs page so it uses the blob URL form
rather than tree: replace the current
`/tree/main/apps/ensindexer/src/plugins/index.ts` URL with
`/blob/main/apps/ensindexer/src/plugins/index.ts` in the content of
creating-a-plugin.mdx, ensuring the reference to the plugins index file
(apps/ensindexer/src/plugins/index.ts) points directly to the file view so
readers can easily import the plugin definition into the ALL_PLUGINS array.
In
`@docs/ensnode.io/src/content/docs/docs/services/ensindexer/usage/management.mdx`:
- Line 19: The sentence is ambiguous about deleting an env var versus the
database schema; update the wording so it clearly instructs operators to remove
the old schema(s) from the ENSDb instance (not the environment variable). For
example, rephrase the line that mentions ENSINDEXER_SCHEMA_NAME to say something
like "manually delete any old schema(s) in your ENSDb instance (those schema
names correspond to the ENSINDEXER_SCHEMA_NAME environment variable)". Ensure
the revised text references ENSDb and ENSINDEXER_SCHEMA_NAME so readers
understand the env var names map to schemas to be removed.
- Around line 23-27: The document shows a raw DROP SCHEMA myschema_X CASCADE;
command without any safety guidance; add an explicit destructive-action warning
immediately before the SQL snippet telling users to verify the target database
and schema name, ensure backups or snapshots exist, confirm they are not in
production, and that the operation is irreversible to prevent accidental data
loss; reference the existing SQL example "DROP SCHEMA myschema_X CASCADE;" so
the warning appears directly above that snippet and uses clear actionable steps
(verify target, take backup, run in correct environment).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: d659b927-82f7-4eb6-95fd-0a2ad631e1e4
📒 Files selected for processing (11)
docs/ensnode.io/astro.config.mjsdocs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdxdocs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdxdocs/ensnode.io/src/content/docs/docs/reference/rest-api.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/querying-best-practices.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdxdocs/ensnode.io/src/content/docs/docs/reference/what-is-ensnode.mdxdocs/ensnode.io/src/content/docs/docs/self-host/docker.mdxdocs/ensnode.io/src/content/docs/docs/services/ensapi/index.mdxdocs/ensnode.io/src/content/docs/docs/services/ensindexer/contributing/creating-a-plugin.mdxdocs/ensnode.io/src/content/docs/docs/services/ensindexer/usage/management.mdx
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 17 changed files in this pull request and generated 5 comments.
Comments suppressed due to low confidence (2)
docs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdx:58
- Grammar: "and full the stack of ENSNode services" reads like a typo. Consider changing to "and the full stack of ENSNode services".
purpose="Demonstration of ENSNode's multichain ENS indexing capability for an ENS namespace (mainnet) that is still operating ENSv1. Experience how the ENS Omnigraph API, enssdk, enskit, and full the stack of ENSNode services provide support to developers to become ENSv2 ready even before ENSv2 launches. Provides a superset of the data indexed by the ENS Subgraph. Offers a preview of ENS Protocol Acceleration."
docs/ensnode.io/src/content/docs/docs/integrate/hosted-instances.mdx:68
- Grammar: "and full the stack of ENSNode services" reads like a typo. Consider changing to "and the full stack of ENSNode services".
purpose="Demonstration of ENSNode's multichain ENS indexing capability for an ENS namespace (sepolia) that is still operating ENSv1. Experience how the ENS Omnigraph API, enssdk, enskit, and full the stack of ENSNode services provide support to developers to become ENSv2 ready even before ENSv2 launches. Provides a superset of the data indexed by the ENS Subgraph. Offers a preview of ENS Protocol Acceleration."
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.
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)