chore(docs): 06/01/26 docs refinements#2235
Open
Y3drk wants to merge 6 commits into
Open
Conversation
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Contributor
|
Warning Review limit reached
More reviews will be available in 45 minutes and 56 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds status icon atoms and a NotENSv2ReadyBadge, table/molecule components for cataloging Subgraph-dependent apps, a new "Keep ENS apps working 🚨" documentation page with enumerated entries, and navigation/redirect/CSS/config updates to surface and exclude the page from LLMS exports. ChangesENSv2 Compatibility Documentation with UI Components
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ 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
There was a problem hiding this comment.
Pull request overview
This PR refreshes the docs site's "Why ENSNode?" / ENS Subgraph sections: it splits the long "applications dependent on the ENS Subgraph" content out of ens-subgraph/index.mdx into a new "Keep ENS apps working" page rendered with new UpgradeToOmnigraphRequiredTable / ENSSubgraphDependentApp components and a NotENSv2ReadyBadge, moves ensv2-readiness under why-ensnode/, adds redirects, and updates the sidebar and inbound links accordingly.
Changes:
- New page
keep-ens-working.mdxplus new components (UpgradeToOmnigraphRequiredTable,ENSSubgraphDependentApp,NotENSv2ReadyBadge,SkullIcon,CheckSolidIcon) and supporting CSS class.omnigraph-required-table-content. ens-subgraph/index.mdxslimmed down to point to the new page;why-ensnode/index.mdxsimplified to a single integration-options card and gains a new card linking toens-subgraph.ensv2-readinessrelocated underwhy-ensnode/, with sidebar entries andastro.config.mjsredirects updated.
Reviewed changes
Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/keep-ens-working.mdx | New page listing Subgraph-dependent apps grouped by category. |
| docs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/ensv2-readiness.mdx | New page (moved under why-ensnode/). |
| docs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/index.mdx | Trimmed cards and updated readiness link. |
| docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/index.mdx | Removed inline app list; added link card to new page; section renamed. |
| docs/ensnode.io/src/content/docs/docs/integrate/index.mdx | Updated readiness link path. |
| docs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/index.astro | New wrapper component for the apps table. |
| docs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/ENSSubgraphDependentApp.astro | New row component with transition badge. |
| docs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsx | New badge with tooltip describing transition state. |
| docs/ensnode.io/src/components/atoms/icons/SkullIcon.tsx | New icon used in the badge. |
| docs/ensnode.io/src/components/atoms/icons/CheckSolidIcon.tsx | New icon used in the badge tooltip. |
| docs/ensnode.io/src/styles/starlight.css | Adds .omnigraph-required-table-content to link color/underline rules. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts | Restructures "Why ENSNode?" sidebar group; expands ENS Subgraph. |
| docs/ensnode.io/astro.config.mjs | Updates redirects for relocated readiness page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?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: 5
🤖 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/components/atoms/icons/CheckSolidIcon.tsx`:
- Around line 11-23: The SVG embeds a base64 PNG via pattern0_2974_708 and
image0_2974_708 increasing bundle size; replace that pattern usage with a native
SVG path in the CheckSolidIcon component: remove the <defs> containing
pattern0_2974_708 and image0_2974_708, remove the <rect width="12" height="12"
fill="url(`#pattern0_2974_708`)" /> and instead add a compact <path> that renders
the check/box using the same viewBox/size and use a semantic fill (e.g.,
currentColor or the original color), ensuring the exported CheckSolidIcon.tsx
returns the new path-based SVG.
In
`@docs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/ENSSubgraphDependentApp.astro`:
- Around line 11-13: The class attribute currently wraps a single static string
with the classcat helper `cc([...])`; remove the unnecessary `cc` wrapper and
assign the static class string directly to the `class` attribute in
ENSSubgraphDependentApp.astro (replace usage of `cc([...])` with the raw string
`"w-full h-fit flex flex-col justify-start items-start gap-2.5 px-4 py-3
border-t border-gray-200"`).
- Around line 6-7: Replace the unsafe type assertion by declaring an exported
Props interface that defines toENSNodeSubgraphCompatibleEndpoint and
toOmnigraphAPI (with their proper function/types) and then access typed props
via Astro.props without "as"; specifically, add export interface Props {
toENSNodeSubgraphCompatibleEndpoint: /* appropriate type */, toOmnigraphAPI: /*
appropriate type */ } and then use const { toENSNodeSubgraphCompatibleEndpoint,
toOmnigraphAPI } = Astro.props; to ensure the component is properly type-checked
instead of using ENSSubgraphDependentApplicationTransitionStages as an
assertion.
In `@docs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/index.mdx`:
- Line 41: Heading typo: change "ENSNode Subgraph compatability" to "ENSNode
Subgraph compatibility" in the docs/ensnode.io src content; locate the heading
string "ENSNode Subgraph compatability" in index.mdx and correct the misspelled
word "compatability" to "compatibility" so the heading reads "ENSNode Subgraph
compatibility".
In
`@docs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/keep-ens-working.mdx`:
- Line 67: Extract the repeated inline code styling into a reusable component
(e.g., InlineCode) and replace the duplicated hardcoded <code
class="bg-[var(--sl-color-bg-inline-code)] text-xs px-1.5 py-0.5 -my-0.5"> usage
in the MDX with that component; create InlineCode.astro (or InlineCode.jsx/tsx)
that accepts children and renders them inside the <code> with the Tailwind
classes, then import and use <InlineCode>linea.eth</InlineCode> at both places
(the occurrences referenced by the review) to ensure consistency and
maintainability.
🪄 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: ba434ab4-e390-47b9-bebb-6d9528d49def
📒 Files selected for processing (14)
CLAUDE.mddocs/ensnode.io/astro.config.mjsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsxdocs/ensnode.io/src/components/atoms/icons/CheckSolidIcon.tsxdocs/ensnode.io/src/components/atoms/icons/SkullIcon.tsxdocs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/ENSSubgraphDependentApp.astrodocs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/index.astrodocs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/ensv2-readiness.mdxdocs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/why-ensnode/keep-ens-working.mdxdocs/ensnode.io/src/styles/starlight.css
…/chore/ensnodeio-docs-refinements-010626
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsx (2)
59-61: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winRemove the one-off declaration comment for consistency.
The file mostly omits declaration comments; keeping this single block creates inconsistency.
As per coding guidelines, "Maintain comment consistency within a file; if most types, schemas, or declarations lack comments, do not add a comment to a single one."
🤖 Prompt for 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. In `@docs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsx` around lines 59 - 61, Remove the one-off declaration comment above the icon in the NotENSv2ReadyBadge component to restore file comment consistency: locate the comment block "// This icon is located here (and not exported) // because this variant of info icon is only used in this badge // and nowhere else in the codebase" near the icon definition used by NotENSv2ReadyBadge and delete those lines so the icon declaration matches the rest of the file's commenting style.
21-25:⚠️ Potential issue | 🟠 Major | ⚡ Quick winMake the tooltip trigger keyboard-accessible.
Line 21 uses a non-focusable
<span>as the tooltip trigger, so keyboard users can’t reliably open/read this content.Suggested fix
- <span className="w-fit flex flex-row flex-nowrap justify-center items-center gap-1 px-1.5 py-0.5 rounded-sm text-white bg-red-500 cursor-default font-semibold leading-5 text-xs"> + <button + type="button" + aria-label="ENSv2 readiness details" + className="w-fit flex flex-row flex-nowrap justify-center items-center gap-1 px-1.5 py-0.5 rounded-sm text-white bg-red-500 cursor-default font-semibold leading-5 text-xs" + > <SkullIcon className="w-3 h-3 shrink-0" /> ENSv2 not ready <NotENSv2ReadyInfoIcon className="w-3 h-3 shrink-0 opacity-50" /> - </span> + </button>🤖 Prompt for 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. In `@docs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsx` around lines 21 - 25, The tooltip trigger in NotENSv2ReadyBadge is a non-focusable span, so keyboard users can’t access the tooltip reliably. Update the trigger element inside NotENSv2ReadyBadge to use a keyboard-focusable control or otherwise make it focusable and operable from the keyboard, while preserving the existing badge styling and icon layout. Keep the tooltip behavior attached to the existing trigger content so the ENSv2 not ready badge remains visually unchanged but accessible.
🤖 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.
Outside diff comments:
In `@docs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsx`:
- Around line 59-61: Remove the one-off declaration comment above the icon in
the NotENSv2ReadyBadge component to restore file comment consistency: locate the
comment block "// This icon is located here (and not exported) // because this
variant of info icon is only used in this badge // and nowhere else in the
codebase" near the icon definition used by NotENSv2ReadyBadge and delete those
lines so the icon declaration matches the rest of the file's commenting style.
- Around line 21-25: The tooltip trigger in NotENSv2ReadyBadge is a
non-focusable span, so keyboard users can’t access the tooltip reliably. Update
the trigger element inside NotENSv2ReadyBadge to use a keyboard-focusable
control or otherwise make it focusable and operable from the keyboard, while
preserving the existing badge styling and icon layout. Keep the tooltip behavior
attached to the existing trigger content so the ENSv2 not ready badge remains
visually unchanged but accessible.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 6e7ebd9c-e974-4bcb-a85a-f77ce679aacd
📒 Files selected for processing (6)
docs/ensnode.io/config/integrations/llms-txt.tsdocs/ensnode.io/src/components/atoms/NotENSv2ReadyBadge.tsxdocs/ensnode.io/src/components/atoms/icons/CheckSolidIcon.tsxdocs/ensnode.io/src/components/atoms/icons/SkullIcon.tsxdocs/ensnode.io/src/components/molecules/upgrade-to-omnigraph-required-table/ENSSubgraphDependentApp.astrodocs/ensnode.io/src/content/docs/docs/integrate/ens-subgraph/index.mdx
Contributor
Greptile SummaryThis PR restructures the "Integrate with ENSv2" documentation section by splitting the
Confidence Score: 5/5Safe to merge — pure documentation and UI additions with no logic-bearing code paths changed. All changes are confined to docs content, new display-only React/Astro components, sidebar config, and redirect rules. The keep-ens-working page exclusion from the LLMs-txt plugin is deliberate and documented. Redirects correctly cover the moved ensv2-readiness page. No data flow, auth, or API surface is touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["/docs/integrate"] --> B["Why ENSNode?"]
B --> C["Overview /why-ensnode/index.mdx"]
B --> D["Keep ENS apps working /why-ensnode/keep-ens-working.mdx NEW"]
B --> E["ENSv2 Readiness /why-ensnode/ensv2-readiness.mdx MOVED"]
R1["/docs/integrate/migrate-from-subgraph"] -->|redirect| E
R2["/docs/reference/ensnode-v2-notes"] -->|redirect| E
R3["/docs/reference/roadmap"] -->|redirect| E
R4["/docs/integrate/ensv2-readiness"] -->|redirect NEW| E
D --> F["UpgradeToOmnigraphRequiredTable Astro"]
F --> G["ENSSubgraphDependentApp Astro"]
G --> H["NotENSv2ReadyBadge React client:load"]
H --> I["Tooltip @namehash/namehash-ui"]
H --> J["CheckSolidIcon / SkullIcon / XMarkIcon"]
Reviews (3): Last reviewed commit: "Apply AI agents' suggestions, pt.2" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Member
Author
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 → 06/01/26 docs refinements
Summary
Why
Testing
lintcommand locally to ensure that the migration didn't break anything, and later confirmed that in our CI workflowNotes for Reviewer (Optional)
IMPORTANT
I had to temporarily exclude the
docs/integrate/why-ensnode/keep-ens-workingpage from thestarlightLlmsTxtplugin, because it was causing a build error due to it having a React-based tooltip.I understand that such a situation is not ideal, but I decided to go with this solution because:
starlightLlmsTxtplugin is not currently essential for usI want to find a better solution for this, and I documented it in Issue #2238
Pre-Review Checklist (Blocking)