Update /docs/hosted-instances page#2173
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR restructures hosted ENSNode instance documentation and components to present instance metadata, version information, and API details via structured slot-based content instead of inline descriptive text. Component props are updated, new compatibility constants are exported, all instance examples are refactored, and navigation labels are improved. ChangesHosted Instance Documentation Refactoring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/molecules/HostedEnsNodeInstances.astro`:
- Line 6: The version constant ensNodeVersion is malformed ("v.1.13.1" has an
extra dot); update the value of ensNodeVersion to a correctly formatted semantic
label such as "v1.13.1" (or "1.13.1" if the leading "v" is not desired) so the
docs UI renders the version without the stray period.
🪄 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: 9466a0ae-3eb8-4f06-a338-17edf6441326
📒 Files selected for processing (4)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astrodocs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astrodocs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
Greptile SummaryThis PR updates the
Confidence Score: 4/5Safe to merge after fixing the NOTE bold-text rendering across the five instance tables. The docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx — the two string constants with Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
MDX["hosted-instances.mdx\n(HTML string constants + MDX content)"]
COMP["HostedEnsNodeInstance.astro\n(renamed component)"]
WARN["HostedInstanceSdkVersionWarning.astro"]
VER["ACTIVE_OMNIGRAPH_VERSION"]
MDX -->|"import + props\n(instanceURL, namespace, ensVersions, plugins)"| COMP
MDX -->|"named slots set:html\n(ens-omnigraph-api, ens-subgraph-api,\nens-protocol-acceleration)"| COMP
VER -->|"hostedEnsNodeVersion"| COMP
VER -->|"VERSION (v-stripped)"| WARN
MDX -->|"import"| WARN
COMP --> TABLE["Rendered Table\n- Hosted at\n- ENSNode Version\n- ENS Namespace\n- ENS Versions\n- ENSNode Plugins\n- ENS APIs (dl/dt/dd)"]
Reviews (3): Last reviewed commit: "Apply PR feedback" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Updates the docs site’s “Hosted ENSNode Instances” content to more clearly communicate what each hosted endpoint supports (namespace, ENS deployments, and API compatibility), and tweaks related navigation/wording for better clarity.
Changes:
- Expanded
/docs/hosted-instancesto describe per-instance API support (Omnigraph/Subgraph/Protocol Acceleration) and ENS deployment coverage. - Updated the hosted-instance UI component to display ENSNode version, deployments, and API descriptions via slots.
- Refined docs UI copy and sidebar labels for clearer integration navigation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx | Reworks the hosted instances page to highlight APIs/compatibility and adds new per-instance descriptions. |
| docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro | Adjusts the warning copy to link to the hosted instances page. |
| docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro | Updates the instance summary table to include version/deployments and API slots. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts | Renames sidebar labels to be more explicit/concise. |
💡 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}
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Hey excited for the updates here. Provided detailed feedback. Please take the lead to action my suggestions and merge this PR for us. Thank you!
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Hey excited for the updates here. Provided detailed feedback. Please take the lead to action my suggestions and merge this PR for us. Thank you!
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/hosted-instances.mdx`:
- Around line 12-13: The Markdown bold markers are being injected via Astro's
set:html (raw HTML), so the literal "**NOTE:**" is rendered instead of bold;
update the string constants subgraphCompatibilityApiLevel and
subgraphCompatibilityFull to use real HTML tags (e.g., replace "**NOTE:**" with
"<strong>NOTE:</strong>" or "<b>NOTE:</b>") and ensure any other Markdown-style
bold in those exported template strings is converted to equivalent HTML so the
injected HTML renders as intended.
🪄 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: 71dd923d-ac9e-44b9-bc87-819a27fef46e
📒 Files selected for processing (4)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/components/molecules/HostedEnsNodeInstance.astrodocs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astrodocs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
| export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb (including Basenames, Lineanames, and 3DNS). This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; | ||
| export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
In Astro, when content is inserted via set:html, is Markdown syntax like NOTE: parsed, or is it rendered as literal text unless converted to HTML tags?
💡 Result:
In Astro, set:html does not parse Markdown. It injects the provided string as HTML (similar to el.innerHTML), so Markdown syntax like NOTE: will be treated as literal text unless you first convert it to actual HTML (e.g., <strong>NOTE:</strong>). Astro’s set:html directive is explicitly documented as “inject[ing] an HTML string … similar to setting el.innerHTML” and that the value is “not automatically escaped by Astro” [1]. Therefore, if you pass Markdown content to set:html, Astro will not run remark/Markdown parsing on it; it will just output that text into the HTML context. Astro’s Markdown parsing happens via its Markdown pipeline for Markdown files/content collections, not via set:html itself [2].
Citations:
- 1: https://docs.astro.build/en/reference/directives-reference/
- 2: https://docs.astro.build/en/guides/markdown-content/
Fix Markdown bold in set:html payloads (hosted-instances.mdx lines 12-13)
Astro set:html injects the string as raw HTML (no Markdown parsing), so **NOTE:** will render literally. Use real HTML instead.
💡 Proposed fix
-export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb (including Basenames, Lineanames, and 3DNS). This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`;
+export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb (including Basenames, Lineanames, and 3DNS). This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different. <strong>NOTE:</strong> As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`;
-export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`;
+export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API. <strong>NOTE:</strong> As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`;📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb (including Basenames, Lineanames, and 3DNS). This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; | |
| export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API. **NOTE:** As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; | |
| export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb (including Basenames, Lineanames, and 3DNS). This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different. <strong>NOTE:</strong> As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; | |
| export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API. <strong>NOTE:</strong> As soon as ENSv2 launches the ENS Subgraph will no longer return correct data. Transition your apps now to the new ENS Omnigraph API to be ENSv2 ready.`; |
🤖 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/content/docs/docs/hosted-instances.mdx` around lines 12 -
13, The Markdown bold markers are being injected via Astro's set:html (raw
HTML), so the literal "**NOTE:**" is rendered instead of bold; update the string
constants subgraphCompatibilityApiLevel and subgraphCompatibilityFull to use
real HTML tags (e.g., replace "**NOTE:**" with "<strong>NOTE:</strong>" or
"<b>NOTE:</b>") and ensure any other Markdown-style bold in those exported
template strings is converted to equivalent HTML so the injected HTML renders as
intended.
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
/docs/hosted-instancespage to better highlight each instances' APIs and data source (ENS deployment).Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)