Skip to content

feat(docs): add visuals and explanations for ENS name healing process#2270

Merged
lightwalker-eth merged 3 commits into
mainfrom
key-limitations-ensrainbow
Jun 7, 2026
Merged

feat(docs): add visuals and explanations for ENS name healing process#2270
lightwalker-eth merged 3 commits into
mainfrom
key-limitations-ensrainbow

Conversation

@djstrong
Copy link
Copy Markdown
Member

@djstrong djstrong commented Jun 6, 2026

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • What changed (1-3 bullets, no essays).

Why

  • Why this change exists. Link to related GitHub issues where relevant.

Testing

  • How this was tested.
  • If you didn't test it, say why.

Notes for Reviewer (Optional)

  • Anything non-obvious or worth a heads-up.

Pre-Review Checklist (Blocking)

  • This PR does not introduce significant changes and is low-risk to review quickly.
  • Relevant changesets are included (or are not required)

Copilot AI review requested due to automatic review settings June 6, 2026 21:05
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jun 6, 2026

⚠️ No Changeset found

Latest commit: d2de969

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
Copy link
Copy Markdown
Contributor

vercel Bot commented Jun 6, 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 Jun 7, 2026 2:16pm
ensnode.io Ready Ready Preview, Comment Jun 7, 2026 2:16pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped Jun 7, 2026 2:16pm
ensrainbow.io Skipped Skipped Jun 7, 2026 2:16pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 6, 2026

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: cb0ab724-2698-440b-8a7a-f65f0d3a4e89

📥 Commits

Reviewing files that changed from the base of the PR and between 68da633 and d2de969.

📒 Files selected for processing (1)
  • docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx

📝 Walkthrough

Walkthrough

Updated key-limitations.mdx to expand the "Unhealed names" section with encoded labelhash placeholders, two example links, new visuals (unhealed listing, coverage chart, healed/unhealed split), updated healing coverage stats attributing ~94% to ENSNode+ENSRainbow vs ~11% legacy, and a pointer to ENSRainbow for request-time healing.

Changes

ENS Label Healing Documentation

Layer / File(s) Summary
Unhealed Names Explanation and Healing Coverage
docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx
Replaced brief "~94% healed" tip with expanded section explaining encoded labelhashes ([428...b0b]) as unknown-label placeholders, added illustrative links and images showing unhealed vs healed labels, updated healing coverage descriptions for ENSNode + ENSRainbow vs legacy Subgraph (stated ~94% vs ~11%) with a ~99% target, and referenced ENSRainbow for request-time label healing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • namehash/ensnode#2121: MDX documentation updates under the same integrate docs area; related phrasing and integration guidance adjustments.
  • namehash/ensnode#1513: Adds a dedicated unknown-labels.mdx page documenting encoded labelhash placeholders and unhealed label mechanisms related to this update.

Suggested labels

docs, ensrainbow

Poem

A rabbit hops through ENS domains bright,
Finding hashed names hidden from sight,
It paints them healed with Rainbow cheer,
Links and charts make the picture clear,
Hopping onward, docs now gleam — goodnight! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning PR description uses the template structure but fails to populate required sections with actual content. Fill in the Summary (1-3 bullets about what changed), Why (rationale and related issues), and Testing (how tested or why not) sections with substantive information.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding visuals and explanations for the ENS name healing process in documentation.
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 key-limitations-ensrainbow

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.

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

Updates the ENS Subgraph “Key limitations” documentation to better explain the ENS name healing problem (unhealed labelhashes) and visually illustrate the impact and current/target healing coverage, positioning ENSNode’s Omnigraph + ENSRainbow as the solution.

Changes:

  • Adds a plain-language explanation of encoded labelhashes with real-world examples.
  • Adds new visuals (unhealed profile example, healing coverage chart, healed vs unhealed split).
  • Updates the healing-coverage comparison copy to reference ENSRainbow and current coverage numbers.

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

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.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: 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/ens-subgraph/key-limitations.mdx`:
- Around line 184-186: Update the MDX copy that currently states "ENSRainbow has
healed 259,053,605 unknown labels so far" to include a timestamp (e.g., "as of
26 May 2026") immediately after the numeric count so the snapshot is
date-stamped; edit the tip block containing the "Omnigraph API" / ENSRainbow
paragraph to append "as of <DATE>" (or use the same date used in the image alt
text) and ensure the wording matches the alt text for consistency.
- Line 180: The text uses three ASCII dots in the label example "[428...b0b]";
replace that sequence with the single typographic ellipsis character so it reads
"[428…b0b]" (use U+2026) to match the other occurrence and keep typography
consistent across the document.
🪄 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: 09693754-f606-4942-894e-6a11f46cb5c2

📥 Commits

Reviewing files that changed from the base of the PR and between 1a0806b and 68da633.

⛔ Files ignored due to path filters (3)
  • docs/ensnode.io/src/assets/ens-profile-unhealed.svg is excluded by !**/*.svg
  • docs/ensnode.io/src/assets/healed-name-split.png is excluded by !**/*.png
  • docs/ensnode.io/src/assets/healing-coverage.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io June 6, 2026 21:15 Inactive
@vercel vercel Bot temporarily deployed to Preview – admin.ensnode.io June 6, 2026 21:15 Inactive
@djstrong djstrong marked this pull request as ready for review June 6, 2026 21:19
@djstrong djstrong requested a review from a team as a code owner June 6, 2026 21:19
Copilot AI review requested due to automatic review settings June 6, 2026 21:19
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 1 out of 4 changed files in this pull request and generated 3 comments.

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jun 6, 2026

Greptile Summary

This PR enriches the "Unhealed names" section of the ENS Subgraph key-limitations doc with three new visual assets (an SVG illustration and two PNGs) and supporting prose that explains what labelhash names look like, how healing coverage compares across implementations, and how ENSRainbow resolves the problem.

  • Adds a new intro paragraph with real-world ENS app links demonstrating the unhealed-name problem, followed by the new ens-profile-unhealed.svg illustration.
  • Updates the tip callout to cite ENSRainbow explicitly and adds the healing-coverage.png chart and healed-name-split.png comparison image.
  • One link (ensrainbow.io) is missing its https:// scheme and will render as a broken relative URL in the built site.

Confidence Score: 4/5

Safe to merge after fixing the broken ensrainbow.io link, which will resolve as a relative URL in the built site.

The only functional defect is the missing https:// scheme on the ENSRainbow link in the tip callout — without it, built Starlight/Astro docs will produce a relative link that 404s. All three image assets are correctly referenced via @assets/ aliases and the surrounding prose is accurate.

docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx — broken link on line 185.

Important Files Changed

Filename Overview
docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Adds explanatory paragraph, three image embeds, and an updated tip callout for the name-healing section; contains one broken link (ensrainbow.io missing https:// scheme).
docs/ensnode.io/src/assets/ens-profile-unhealed.svg New SVG illustration of an ENS profile showing unhealed labelhash names; no code issues.
docs/ensnode.io/src/assets/healed-name-split.png New PNG showing a healed vs unhealed name side-by-side; binary asset, no issues.
docs/ensnode.io/src/assets/healing-coverage.png New PNG chart showing label healing coverage percentages; binary asset, no issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Reader lands on key-limitations page] --> B[Sees 'Unhealed names' section]
    B --> C[New: Intro paragraph + Example links]
    C --> D[New: ens-profile-unhealed.svg]
    D --> E[Updated tip callout — ENSRainbow stats]
    E --> F[New: healing-coverage.png chart]
    F --> G[New: Explanatory prose about healed names]
    G --> H[New: healed-name-split.png comparison]
    H --> I[Link to ENSRainbow service docs]
Loading

Reviews (2): Last reviewed commit: "Update docs/ensnode.io/src/content/docs/..." | Re-trigger Greptile

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
Copy link
Copy Markdown
Member

@lightwalker-eth lightwalker-eth left a comment

Choose a reason for hiding this comment

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

@djstrong looks good, thanks 👍

Comment thread docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/key-limitations.mdx Outdated
Copilot AI review requested due to automatic review settings June 7, 2026 14:14
@vercel vercel Bot temporarily deployed to Preview – admin.ensnode.io June 7, 2026 14:14 Inactive
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io June 7, 2026 14:14 Inactive
@lightwalker-eth lightwalker-eth merged commit 2855255 into main Jun 7, 2026
15 of 19 checks passed
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 1 out of 4 changed files in this pull request and generated 1 comment.


:::tip[~94% healed, and climbing]
The [Omnigraph API](/docs/integrate/omnigraph) already heals **~94%** of these labels, compared to roughly **10%** with the label set bundled in the traditional ENS Subgraphand climbing toward a **99%** target.
ENSNode already heals **~94%** of these labels with [ENSRainbow](/docs/services/ensrainbow), compared to **~11%** with the label set bundled into the traditional ENS Subgraph. [ENSRainbow](ensrainbow.io) has data for healing **259,053,605** unknown labels as of May 2026, and coverage is climbing toward a **99%** target.
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.

3 participants