Refine ENSAdmin docs#2118
Conversation
Refine as per feedback from Slack
Use current UI screenshots to provide an introduction into ENSAdmin functionality.
🦋 Changeset detectedLatest commit: 08803aa The changes in this PR will be included in the next version bump. This PR includes changesets to release 25 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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 ignored due to path filters (4)
📒 Files selected for processing (6)
✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR refines the ENSAdmin section of the ENSNode docs site: it merges the standalone "What is ENSAdmin?" page into the section's index, splits the previous index (Docker quickstart) into a dedicated "Using Docker" page under Contributing, and updates sidebar topics accordingly. It also includes non-docs changes to the ENSAdmin app's EnsNodeStackInfoCardContent, removing the Subgraph Compatibility InfoCardFeature in favor of a new InfoCardItem-based presentation and conditionally rendering activated/deactivated feature lists.
Changes:
- Move "What is ENSAdmin?" content to become the ENSAdmin section entrypoint (
index.mdx) and delete the standalone overview page; update the services sidebar to add a nested Contributing → Using Docker entry. - Extract the prior Docker quickstart into a new
contributing/docker.mdxpage. - In
ensnode-stack-info.tsx, replace theSubgraph Compatibilityfeature card with two newInfoCardItemvariants and only render activated/deactivatedInfoCardFeatureswhen non-empty; several related blocks are commented out rather than removed.
Reviewed changes
Copilot reviewed 6 out of 10 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/ensadmin/overview/what-is-ensadmin.mdx | Deleted; content folded into the section index. |
| docs/ensnode.io/src/content/docs/docs/services/ensadmin/index.mdx | Now the ENSAdmin entrypoint with overview + key features and screenshots. |
| docs/ensnode.io/src/content/docs/docs/services/ensadmin/contributing/docker.mdx | New page containing the Docker quickstart previously in the index. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts | Restructures ENSAdmin sidebar to nest Contributing with a Docker sub-item. |
| apps/ensadmin/src/components/connection/cards/ensnode-stack-info.tsx | Reworks Subgraph Compatibility presentation and conditional feature rendering; leaves several blocks commented out and creates dead imports/locals. |
Comments suppressed due to low confidence (1)
apps/ensadmin/src/components/connection/cards/ensnode-stack-info.tsx:395
- This block is commented out rather than removed. Same concern as the earlier comment in this file: please delete the dead code (and the matching block at lines 444-453) instead of leaving it commented in source.
{/* <InfoCardFeatures activated={ensApiPublicConfig.theGraphFallback.canFallback}>
<InfoCardFeature
label="Subgraph API Fallback"
description={
ensApiPublicConfig.theGraphFallback.canFallback ? (
<p>
ENSApi's Subgraph API (/subgraph) will automatically fallback to The Graph if the
connected ENSIndexer is not sufficiently "realtime".
</p>
) : (
<p>
ENSApi's Subgraph API (/subgraph) will NOT fallback to The Graph if the connected
ENSIndexer is not sufficiently "realtime". {(() => {
switch (ensApiPublicConfig.theGraphFallback.reason) {
case "not-subgraph-compatible":
return "The connected ENSIndexer is not Subgraph Compatible.";
case "no-api-key":
return "No API key for The Graph is configured.";
case "no-subgraph-url":
return "The Graph does not provide an ENS Subgraph for the configured ENS Namespace.";
default:
return null;
}
})()}
</p>
)
}
icon={<History width={15} height={15} className="shrink-0" />}
/>
</InfoCardFeatures> */}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| description: An overview of the ENSAdmin project. | ||
| sidebar: | ||
| label: What is ENSAdmin? | ||
| order: 1 # Or an appropriate order number |
| @@ -0,0 +1,35 @@ | |||
| --- | |||
| title: Docker | |||
Greptile SummaryThis PR refines the ENSAdmin section of the ENSNode docs and updates the ENSAdmin Connection view UI. The docs are reorganized so the "What is ENSAdmin?" overview becomes the section entry point, the Docker quickstart moves to its own page, and four new screenshot assets are added to illustrate key features.
Confidence Score: 5/5Safe to merge — changes are documentation restructuring and a UI refinement with no functional regressions. All changes are either documentation reorganization or cosmetic UI updates to the ENSAdmin Connection view. The component logic correctly guards empty feature sections, and the new Subgraph Compatibility item renders on both branches. No data flow, API contracts, or core indexing logic is touched. No files require special attention beyond the minor style note on the new Subgraph Compatibility InfoCardItem. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[EnsNodeStackInfoCardContent] --> B{ensIndexerFeaturesActivated.length > 0?}
B -- Yes --> C[Render InfoCardFeatures activated=true]
B -- No --> D[null]
A --> E{ensIndexerFeaturesDeactivated.length > 0?}
E -- Yes --> F[Render InfoCardFeatures activated=false]
E -- No --> G[null]
A --> H{subgraphCompatibilityActivated?}
H -- true --> I[InfoCardItem: Full Subgraph Compatibility]
H -- false --> J[InfoCardItem: API-level Subgraph Compatibility]
A --> K[InfoCardItem: Client LabelSet]
Reviews (2): Last reviewed commit: "Apply PR feedback" | Re-trigger Greptile |
![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
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Nice updates here 👍 Shared a few small comments. Please take the lead to merge 🚀
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)