Skip to content

docs refinements#2121

Merged
lightwalker-eth merged 7 commits into
mainfrom
small-docs-refinements
May 14, 2026
Merged

docs refinements#2121
lightwalker-eth merged 7 commits into
mainfrom
small-docs-refinements

Conversation

@lightwalker-eth
Copy link
Copy Markdown
Member

Incremental refinements to the ENSNode docs

Copilot AI review requested due to automatic review settings May 14, 2026 20:08
@lightwalker-eth lightwalker-eth requested a review from a team as a code owner May 14, 2026 20:08
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 14, 2026

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

Project Deployment Actions Updated (UTC)
enskit-react-example.ensnode.io Ready Ready Preview, Comment May 14, 2026 8:59pm
ensnode.io Ready Ready Preview, Comment May 14, 2026 8:59pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped May 14, 2026 8:59pm
ensrainbow.io Skipped Skipped May 14, 2026 8:59pm

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 14, 2026

⚠️ No Changeset found

Latest commit: 7fcfff9

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 14, 2026

Review Change Stack

Warning

Rate limit exceeded

@lightwalker-eth has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 9 minutes and 16 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: cd068028-2f0d-4faf-90ec-f86082476bde

📥 Commits

Reviewing files that changed from the base of the PR and between a49d4fb and 7fcfff9.

📒 Files selected for processing (3)
  • docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/index.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx
📝 Walkthrough

Walkthrough

Documentation updates explaining how ENSNode's unified architecture—ENSIndexer's indexed model (ENSDb) plus ENS Omnigraph API—consolidates prior ENS integration constraints. ENSv2 readiness page reframed as response to historical limitations; quickstart and ENSDb pages updated to emphasize unified tooling across ENSv1 and ENSv2 with concurrent support.

Changes

ENSv2 Readiness and Integration Documentation

Layer / File(s) Summary
ENSv2 Readiness Page Narrative Rewrite
docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
Replaced the prior "ENSv1 integrations today" problem/solution framing with a "Historical limitations of building on ENS" section describing split between CCIP-read capable resolution and indexed subgraph data. Updated explanation to detail how ENSIndexer's unified "unigraph" model in ENSDb and the ENS Omnigraph GraphQL API (via ENSApi) consolidate both resolution and indexed ENS state. Changed "What you need to do" from a migration checklist to a "Coming Soon" caution block indicating active development.
Integration Overview and ENSDb Positioning
docs/ensnode.io/src/content/docs/docs/integrate/index.mdx, docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx
Simplified ENSv2 introductory description on index page to focus on fundamental onchain data model change. Rewrote "ENS Omnigraph" section to emphasize unified API across ENSv1 and ENSv2 with explicit concurrent support language. Added new "See all Integration Options" LinkCard. Repositioned ENSDb as bi-directional integration standard for unified live onchain state of both ENSv1 and ENSv2 in standardized PostgreSQL model.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

  • namehash/ensnode#2068: Doc rewrites directly address requested ENSNode documentation reframe and content updates for ENSv2 readiness, ENS Omnigraph, and ENSDb positioning.

Possibly related PRs

  • namehash/ensnode#2106: Updates the same ENSv2 readiness and Omnigraph integration narrative across integration documentation pages.
  • namehash/ensnode#2099: Modifies the same ensv2-readiness.mdx page with overlapping ENSv2 readiness content updates.
  • namehash/ensnode#2051: Originally structured the ENSv2 quickstart and integration pages that are now being rewritten with updated narrative.

Suggested labels

docs

Poem

🐰 A tale of unified ENS grace,
Where Omnigraph brings protocols to one place,
v1 and v2 in harmony dance,
ENSDb gives indexed state its chance,
Historical limits now fade away,
Consolidation brightens the way! ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete; it lacks the required sections from the template including Summary (bullets of what changed), Why, Testing, and Pre-Review Checklist. Follow the Lite PR template by adding Summary bullets, Why section with rationale, Testing section, and completing the Pre-Review Checklist.
Title check ❓ Inconclusive The title 'docs refinements' is vague and generic, using non-descriptive language that doesn't convey meaningful information about the specific changes made to the documentation. Use a more specific title that describes the key changes, such as 'Update ENSv2 readiness and ENSDb documentation' or 'Refactor ENS integration docs for clarity'.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch small-docs-refinements

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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 and usage tips.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 14, 2026

Greptile Summary

This PR refines the ENSNode integration documentation across three pages, expanding technical detail on the historical limitations of ENS and how ENSNode addresses them, while replacing the "What you need to do" section with a Coming Soon placeholder.

  • ensv2-readiness.mdx: Rewrites the problem/solution sections with richer detail about the ENSIndexer unigraph plugin, ENSDb, ENSApi, and ENS Protocol Acceleration; replaces the actionable steps section with a dated placeholder pending further work.
  • index.mdx: Simplifies the ENSv2 description, restructures integration option headings under a new H2, and adds a bottom LinkCard to the full integration catalog.
  • ensdb.mdx: Corrects the scope language to reflect ENSv1 and ENSv2 coverage and softens the "What you can build" heading to "Inspirations for what you can build".

Confidence Score: 5/5

Documentation-only changes with no functional code impact; safe to merge.

All three files contain only prose and MDX markup changes. The ensdb.mdx correction and index.mdx restructuring are straightforward and accurate. The ensv2-readiness.mdx page is explicitly marked in-progress with a placeholder, so its incomplete state is intentional and visible to readers.

docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx warrants a second pass once the placeholder content is filled in.

Important Files Changed

Filename Overview
docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Major rewrite of the body content: historical limitations and ENSNode solution sections expanded with new detail, while "What you need to do" is replaced with a "Coming Soon" placeholder. The "Be ready!" Aside still makes a strong forward promise not yet backed by actionable guidance, and a repeated ENSIP explanation clause appears in both the intro paragraph and a bullet point.
docs/ensnode.io/src/content/docs/docs/integrate/index.mdx Section headings for numbered integration examples promoted from H2 to H3 under a new "ENSNode's Integration Options" H2; wording updated to clarify ENSv1/ENSv2 coexistence; new LinkCard added at the bottom pointing to the full integration catalog.
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Intro sentence and definition updated to accurately reflect ENSv1 and ENSv2 coverage (not ENSv2-only); section heading rephrased from "What you can build" to "Inspirations for what you can build".

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[App Developer] -->|GraphQL query| B[ENS Omnigraph API\nvia ENSApi]
    B -->|reads unified data model| C[ENSDb\nPostgreSQL]
    B -->|CCIP-read on your behalf| D[Offchain Data Sources]
    E[ENSIndexer\nunigraph plugin] -->|indexes| C
    F[ENSv1 Nametrees\nMainnet · Base · Linea · 3DNS] -->|onchain state| E
    G[ENSv2 Namegraph] -->|onchain state| E
    C -->|direct SQL access| H[Advanced / Self-hosted\nEnsDbReader]
    B --> I[enskit\nReact hooks]
    B --> J[enssdk\nTypeScript client]
    B --> K[Raw GraphQL\nRelay spec]
Loading

Reviews (7): Last reviewed commit: "apply agent suggestions" | Re-trigger Greptile

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Incremental documentation refinements for ENSNode integration guidance, especially around ENSv2, ENS Omnigraph, and ENSDb positioning.

Changes:

  • Updates ENSDb copy to describe unified ENSv1/ENSv2 coverage.
  • Reworks the ENSv2 quickstart introduction and adds a link back to all integration options.
  • Replaces much of the ENSv2 readiness guidance with revised explanatory content and a coming-soon notice.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Updates ENSDb overview wording and use-case heading.
docs/ensnode.io/src/content/docs/docs/integrate/index.mdx Refines ENSv2/Omnigraph quickstart copy and adds an integration-options link card.
docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Rewrites readiness narrative around ENSNode, ENSIndexer, ENSApi, and Omnigraph.
Comments suppressed due to low confidence (1)

docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx:29

  • The punctuation in “etc..)” has an extra period.
[ENSIndexer](/docs/services/ensindexer) offers the `unigraph` plugin, which builds a **unified** polymorphic indexed data model in [ENSDb](/docs/services/ensdb) of multiple ENSv1 Nametrees (the ENSv1 onchain state model found in the ENS root registry, Basenames on Base, Lineanames on Linea, 3DNS on Optimism, etc..), and the ENSv2 Namegraph (the ENSv2 onchain state model that may contain cycles, disjoint domains, and allows domains to dynamically reposition themselves across time within the ENSv2 Namegraph).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/index.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 23: The long run-on sentence starting "The Subgraph gives you queryable
indexed ENS data but is single-chain..." should be split into a short
introductory sentence and a bullet list enumerating each limitation (e.g.,
single-chain scope; no support for ENSv2 data model changes; cannot perform ENS
resolutions; lacks understanding of ENSIP-10/ENSIP-19/ENSIP-15 name
normalization; exposes internal implementation details; other key limitations).
Apply the same treatment to the other dense sentences referenced (the ones
around lines mentioning ENSIP-10/19 and name normalization): break them into 1–2
short sentences or a bullet list so each technical concept is isolated and
easier to read, keeping the phrasing and examples intact (use the original
phrases like "ENSIP-10", "ENSIP-19", "ENSIP-15", "ENS resolutions") for clarity.
- Line 23: In the sentence starting "The Subgraph gives you queryable indexed
ENS data..." replace the erroneous "etc..," sequence with a single period (i.e.,
"etc.,") so the abbreviation ends with one period; update the text inside that
sentence (the string containing "etc.., exposes") to "etc.," to fix the
typographical error.

In
`@docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx`:
- Line 12: Clarify the phrase "bi-directional integration standard" in the ENSDb
description by explicitly stating what the two directions are (for example
"onchain ↔ database synchronization" or "read and write operations between ENS
and Postgres") or replace it with a simpler emphasis on unified ENSv1 and ENSv2
support; update the sentence referencing ENSDb, ENSv1, and ENSv2 to either add a
short parenthetical explanation of the bidirectional flow (onchain ↔ database)
or reword to highlight unified support for ENSv1 and ENSv2 and interoperability
with any Postgres client.
🪄 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: 5ddc2a32-2d70-44cb-9beb-b834af6c2649

📥 Commits

Reviewing files that changed from the base of the PR and between bb7ad4a and a49d4fb.

📒 Files selected for processing (3)
  • docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/index.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Outdated
Copilot AI review requested due to automatic review settings May 14, 2026 20:18
@vercel vercel Bot temporarily deployed to Preview – admin.ensnode.io May 14, 2026 20:18 Inactive
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io May 14, 2026 20:18 Inactive
@lightwalker-eth
Copy link
Copy Markdown
Member Author

@greptile

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io May 14, 2026 20:34 Inactive
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ensv2-readiness.mdx Outdated
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io May 14, 2026 20:58 Inactive
@vercel vercel Bot temporarily deployed to Preview – admin.ensnode.io May 14, 2026 20:58 Inactive
@lightwalker-eth lightwalker-eth merged commit a3747f7 into main May 14, 2026
14 of 17 checks passed
@lightwalker-eth lightwalker-eth deleted the small-docs-refinements branch May 14, 2026 20:58
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.

2 participants