docs pass & omnigraph overview#2142
Merged
Merged
Conversation
Member
shrugs
commented
May 18, 2026
shrugs
commented
- omnigraph overview
- full pass across docs
- hoist hosted instances to top level
Per priority docs pass:
- delete reference/{roadmap,what-is-ensnode,ensnode-v2-notes,mainnet-registered-subnames-of-subregistries} and integrate/migrate-from-subgraph (boss called these stale, lower-value, or "less is more")
- remove their sidebar entries + the stale /ensnode/concepts/what-is-ensnode redirect
- drop the now-dangling 'Skip to What is ENSNode?' LinkCard on reference/subgraph-legacy/what-is-the-ens-subgraph
- drop the 'Coming Soon' panel from integrate/ai-llm (existing content is fine)
- rewrite README around docs/quickstart links + an Omnigraph GraphQL example (inlined eth) sourced from examples/omnigraph-graphql-example
- drop the stale 'docs/ensnode/src/content/docs/reference/mainnet-registered-subnames-of-subregistries.mdx' pointers in datasources comments (mainnet.ts, sepolia.ts)
Follow-ups filed as sub-issues of #1360:
- #2138 docs: write Migrate from ENS Subgraph guide
- #2139 docs: capture mainnet-registered subnames of subregistries
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lead with what ENSNode is for app developers (unified API, multichain, full-stack integration surfaces), not what it is for ENS-the-protocol. Keep the macro arguments (close infra gaps, decentralization) below the fold as supporting context. Drop the Coming Soon banner and the Season 2 video embed. Anchor the "Subgraph won't work for ENSv2" thesis without a feature-comparison table. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
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 (11)
📝 WalkthroughWalkthroughThis PR comprehensively reorganizes the ENSNode documentation site, shifting focus to the Omnigraph API by rewriting core pages, removing legacy/placeholder content, restructuring sidebar navigation, and migrating hosted-instances documentation to a new unified path structure at ChangesENSNode Documentation Site Reorganization
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
Contributor
Greptile SummaryThis PR is a documentation pass for ENSNode that adds a full Omnigraph API overview page, rewrites the "Why ENSNode?" page from a placeholder stub to complete content, hoists the Hosted Instances page to the top-level sidebar, and removes several stale reference pages (roadmap, ENSNode v2 notes, mainnet subnames, what-is-ensnode) with redirect entries.
Confidence Score: 4/5Safe to merge with one broken URL left in the redirect table. The PR removes the redirect entry for docs/ensnode.io/astro.config.mjs — the removed Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["/ensnode/concepts/what-is-ensnode"] -->|removed redirect| X["❌ 404"]
B["/docs/reference/what-is-ensnode"] -->|new redirect| C["/docs/integrate/why-ensnode ✅"]
D["/docs/reference/roadmap"] -->|new redirect| E["/docs/integrate/ensv2-readiness ✅"]
F["/docs/reference/ensnode-v2-notes"] -->|new redirect| E
G["/docs/reference/mainnet-registered-subnames-of-subregistries"] -->|new redirect| H["/docs/integrate/omnigraph ✅"]
I["/docs/integrate/hosted-instances"] -->|new redirect| J["/docs/hosted-instances ✅"]
K["/docs/integrate/migrate-from-subgraph"] -->|new redirect| E
Reviews (3): Last reviewed commit: "fix: tighten up" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![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: 3
🤖 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/ensv2-readiness.mdx`:
- Line 42: Add a comma before "or" in the sentence describing the risk to
clarify the clause; update the line mentioning "`resolve` RPC calls go to the
new `UniversalResolverV2` contract, when it is deployed or risk stale and
incorrect records" to insert a comma before "or" so it reads "...when it is
deployed, or risk stale and incorrect records." Reference tokens: `resolve`,
`UniversalResolverV2`, `viem`, `wagmi`.
- Around line 34-38: The three paragraphs describing The Unigraph Data Model,
The Omnigraph API, and Accelerated ENS Resolution are overly long and should be
split into shorter sentences for clarity: in the paragraph referencing
ENSIndexer, Unigraph and ENSDb, break the single long sentence into 2–3
sentences (introduce ENSIndexer and the unigraph plugin, then list which ENSv1
nametrees it indexes, then separately describe ENSv2 Namegraph behavior); in the
ENS Omnigraph API paragraph referencing ENSApi and ENSDb, separate the
responsibilities (what ENSApi delivers, how it builds on Unigraph/ENSDb, and
which ENSIP standards it understands) into distinct sentences; and in the
Accelerated ENS Resolution paragraph referencing ENSApi and the Universal
Resolver, split the CLAUSE about CCIP-read operations and performance benefits
into at least two sentences (one for how ENSApi implements the resolver and
performs offchain CCIP reads, one for the developer-facing benefits). Use the
symbols ENSIndexer, Unigraph, ENSDb, ENSApi, Omnigraph API, ENS Universal
Resolver and CCIP-read to locate and edit the exact phrases to rewrite.
In
`@docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/what-is-the-ens-subgraph.mdx`:
- Line 121: Replace the incorrect GraphQL metadata field `_Meta_` with the
correct lowercase `_meta` in the unsupported-features list (update the string
`_Meta_` to `_meta`) so the documentation references The Graph subgraph GraphQL
API's actual metadata field name.
🪄 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: 1a0d31ae-a78d-4f18-9268-70ba6ac36b85
📒 Files selected for processing (37)
CONTRIBUTING.mdREADME.mddocs/ensnode.io/astro.config.mjsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/hosted-instances.tsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/index.tsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/reference.tsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/services.tsdocs/ensnode.io/src/components/molecules/IntegrateHostedEnsNodeTip.astrodocs/ensnode.io/src/content/docs/docs/hosted-instances.mdxdocs/ensnode.io/src/content/docs/docs/integrate/ai-llm.mdxdocs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdxdocs/ensnode.io/src/content/docs/docs/integrate/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/omnigraph-graphql-api.mdxdocs/ensnode.io/src/content/docs/docs/integrate/migrate-from-subgraph.mdxdocs/ensnode.io/src/content/docs/docs/integrate/omnigraph/examples/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/omnigraph/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/why-ensnode.mdxdocs/ensnode.io/src/content/docs/docs/reference/ensnode-v2-notes.mdxdocs/ensnode.io/src/content/docs/docs/reference/index.mdxdocs/ensnode.io/src/content/docs/docs/reference/mainnet-registered-subnames-of-subregistries.mdxdocs/ensnode.io/src/content/docs/docs/reference/roadmap.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/what-is-the-ens-subgraph.mdxdocs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/with-ensjs.mdxdocs/ensnode.io/src/content/docs/docs/reference/terminology.mdxdocs/ensnode.io/src/content/docs/docs/reference/what-is-ensnode.mdxdocs/ensnode.io/src/content/docs/docs/self-host/index.mdxdocs/ensnode.io/src/lib/playground/constants.tsdocs/ensnode.io/src/lib/playground/utils.tsexamples/enskit-react-example/src/App.tsxexamples/enssdk-example/src/index.tsexamples/omnigraph-graphql-example/src/index.tspackages/datasources/src/mainnet.tspackages/datasources/src/sepolia.ts
💤 Files with no reviewable changes (9)
- docs/ensnode.io/src/content/docs/docs/reference/roadmap.mdx
- docs/ensnode.io/src/content/docs/docs/integrate/migrate-from-subgraph.mdx
- docs/ensnode.io/src/content/docs/docs/reference/mainnet-registered-subnames-of-subregistries.mdx
- docs/ensnode.io/src/content/docs/docs/reference/what-is-ensnode.mdx
- docs/ensnode.io/src/content/docs/docs/integrate/ai-llm.mdx
- docs/ensnode.io/src/content/docs/docs/reference/ensnode-v2-notes.mdx
- docs/ensnode.io/config/integrations/starlight/sidebar-topics/reference.ts
- packages/datasources/src/sepolia.ts
- packages/datasources/src/mainnet.ts
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes ENSNode documentation around the Omnigraph API, ENSv2 readiness, hosted instances, and sidebar organization while simplifying the root README.
Changes:
- Reworks top-level README and key docs pages to emphasize ENSv2 and the Omnigraph API.
- Hoists hosted ENSNode instances into a top-level docs topic and updates related links/redirects.
- Removes or consolidates older reference/placeholder docs and reorganizes Starlight sidebar topics.
Reviewed changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Simplifies project overview and adds Omnigraph query example. |
CONTRIBUTING.md |
Updates contributing docs link. |
packages/datasources/src/mainnet.ts |
Removes references to deleted reference docs. |
packages/datasources/src/sepolia.ts |
Removes references to deleted reference docs. |
examples/enskit-react-example/src/App.tsx |
Updates hosted instances docs URL. |
examples/enssdk-example/src/index.ts |
Updates hosted instances docs URL. |
examples/omnigraph-graphql-example/src/index.ts |
Updates hosted instances docs URL. |
docs/ensnode.io/astro.config.mjs |
Updates docs redirects. |
docs/ensnode.io/config/integrations/starlight/sidebar-topics/index.ts |
Adds hosted instances topic and reorders topics. |
docs/ensnode.io/config/integrations/starlight/sidebar-topics/hosted-instances.ts |
Adds hosted instances sidebar topic. |
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts |
Adjusts integration sidebar and removes hosted/migration entries. |
docs/ensnode.io/config/integrations/starlight/sidebar-topics/reference.ts |
Removes deleted reference pages from sidebar. |
docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts |
Reorders service sidebar entries. |
docs/ensnode.io/src/components/molecules/IntegrateHostedEnsNodeTip.astro |
Updates hosted instances link. |
docs/ensnode.io/src/lib/playground/constants.ts |
Updates hosted instances path in comment. |
docs/ensnode.io/src/lib/playground/utils.ts |
Updates hosted instances docs path constant. |
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx |
Refreshes hosted instances overview. |
docs/ensnode.io/src/content/docs/docs/self-host/index.mdx |
Updates self-host snapshot and deployment links. |
docs/ensnode.io/src/content/docs/docs/integrate/index.mdx |
Refreshes quickstart content and integration options. |
docs/ensnode.io/src/content/docs/docs/integrate/why-ensnode.mdx |
Replaces placeholder with ENSNode value proposition. |
docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx |
Replaces placeholder with ENSv2 readiness guidance. |
docs/ensnode.io/src/content/docs/docs/integrate/ai-llm.mdx |
Removes coming-soon admonition. |
docs/ensnode.io/src/content/docs/docs/integrate/migrate-from-subgraph.mdx |
Deletes migration placeholder page. |
docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/index.mdx |
Adds Omnigraph API overview. |
docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/examples/index.mdx |
Retitles examples page. |
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/index.mdx |
Updates hosted instances links. |
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/index.mdx |
Updates hosted instances links. |
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/omnigraph-graphql-api.mdx |
Updates hosted instances link. |
docs/ensnode.io/src/content/docs/docs/reference/index.mdx |
Updates hosted instances link. |
docs/ensnode.io/src/content/docs/docs/reference/terminology.mdx |
Moves protocol-extension terminology later and updates ENSRainbow reference. |
docs/ensnode.io/src/content/docs/docs/reference/what-is-ensnode.mdx |
Deletes old ENSNode V1 reference page. |
docs/ensnode.io/src/content/docs/docs/reference/roadmap.mdx |
Deletes roadmap page. |
docs/ensnode.io/src/content/docs/docs/reference/ensnode-v2-notes.mdx |
Deletes V2 notes page. |
docs/ensnode.io/src/content/docs/docs/reference/mainnet-registered-subnames-of-subregistries.mdx |
Deletes subregistry subnames reference page. |
docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/with-ensjs.mdx |
Updates hosted instances link. |
docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/what-is-the-ens-subgraph.mdx |
Adds deprecation note and reorganizes unsupported features. |
docs/ensnode.io/src/content/docs/docs/reference/subgraph-legacy/subgraph-api.mdx |
Adds Subgraph API deprecation callout. |
Comments suppressed due to low confidence (2)
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx:19
- This sentence is missing an article before “ENS protocol deployment,” which makes it read awkwardly. Consider “the ENS protocol deployment indexed by ENSNode.”
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx:25 - Add a comma after “For details” for correct grammar.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lightwalker-eth
approved these changes
May 19, 2026
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@shrugs Hey super to see these docs updates! Reviewed and shared suggestions. Please take the lead to merge this for us 🚀
lightwalker-eth
approved these changes
May 19, 2026
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@shrugs Hey super to see these docs updates! Reviewed and shared suggestions. Please take the lead to merge this for us 🚀
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
- add redirects for the 5 docs pages removed in this branch - narrow relay-spec connection claim (Domain.path/Event.topics are plain arrays) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment on lines
38
to
39
| "/ensnode/deploying/railway": "/docs/services/ensrainbow/deploying/railway", | ||
| "/ensnode/concepts/what-is-ensnode": "/docs/reference/what-is-ensnode", | ||
| "/ensnode/concepts/what-is-the-ens-subgraph": |
Contributor
There was a problem hiding this comment.
The redirect from /ensnode/concepts/what-is-ensnode to /docs/reference/what-is-ensnode was removed in this PR. A new redirect for /docs/reference/what-is-ensnode → /docs/integrate/why-ensnode was added, but Astro static redirects are one-hop and do not chain. Any existing links pointing to /ensnode/concepts/what-is-ensnode (from external sites, blog posts, or social media) will now 404 instead of resolving through the chain to the new page. Adding a direct redirect for that URL would close the gap.
This was referenced May 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.