Skip to content

Update /docs/hosted-instances page#2173

Open
tk-o wants to merge 4 commits into
mainfrom
docs/update-hosted-instances-page
Open

Update /docs/hosted-instances page#2173
tk-o wants to merge 4 commits into
mainfrom
docs/update-hosted-instances-page

Conversation

@tk-o
Copy link
Copy Markdown
Member

@tk-o tk-o commented May 21, 2026

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • Updated the /docs/hosted-instances page to better highlight each instances' APIs and data source (ENS deployment).

Why


Testing

  • Ran the docs website locally and confirmed the updates look fine.

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 May 21, 2026 16:17
@tk-o tk-o requested a review from a team as a code owner May 21, 2026 16:17
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 21, 2026

⚠️ No Changeset found

Latest commit: 28e6450

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 May 21, 2026

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

Project Deployment Actions Updated (UTC)
admin.ensnode.io Ready Ready Preview, Comment May 21, 2026 8:03pm
enskit-react-example.ensnode.io Ready Ready Preview, Comment May 21, 2026 8:03pm
ensnode.io Ready Ready Preview, Comment May 21, 2026 8:03pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
ensrainbow.io Skipped Skipped May 21, 2026 8:03pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Review Change Stack

Warning

Rate limit exceeded

@tk-o has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 41 minutes and 31 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: 0fc9db0e-7ff0-4736-b831-db5ed2ba169d

📥 Commits

Reviewing files that changed from the base of the PR and between 7c3a8fb and 28e6450.

📒 Files selected for processing (3)
  • docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro
  • docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro
  • docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
📝 Walkthrough

Walkthrough

This PR updates the ENSNode hosted instance documentation by refactoring components to support structured metadata display via named slots, exporting reusable compatibility constants, and updating sidebar labels. The changes move instance descriptions from inline purpose text to templated slot content backed by exported constants.

Changes

Hosted Instance Documentation Refactoring

Layer / File(s) Summary
Hosted Instance Components: Metadata and API Display
docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro, docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro
HostedEnsNodeInstances exports ensNodeVersion and adds table rows for version, deployments, and APIs rendered via named slots (ens-omnigraph-api, ens-subgraph-api, ens-protocol-acceleration). HostedInstanceSdkVersionWarning imports LinkButton and uses set:html to render computed SDK version list.
Documentation Content and Compatibility Constants
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
Exports seven string constants describing ENS compatibility states (subgraphCompatibilityApiLevel, omnigraphForEnsV1, ensProtocolAccelerationAvailable, etc.). Refactors v2 Sepolia, Alpha, Alpha-Sepolia, Mainnet, and Sepolia examples to use Fragment slots for API and acceleration details, adds explicit deployments props, and updates plugins lists.
Integration Sidebar Navigation Labels
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts
Updates ENSDb entry label to ENSDb (SQL) and ensdb-cli entry to ensdb-cli (ENSDb Snapshots).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

  • namehash/ensnode#2068: Sidebar label adjustments and hosted-instances content restructuring directly address the documentation organization proposed in this issue.

Possibly related PRs

  • namehash/ensnode#2107: Modifies the same integrateSidebarTopic ENSDb/ensdb-cli sidebar item labels.
  • namehash/ensnode#2158: Updates integrateSidebarTopic sidebar label strings in the same config file.
  • namehash/ensnode#2146: Adds the HostedInstanceSdkVersionWarning component; this PR refines its sdkList rendering behavior.

Suggested labels

docs

Poem

🐰 The docs hop forth with structured grace,
Slots and constants fill their place.
Metadata shines in tables bright,
ENSNode instances gleam with light!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly relates to the main change: updating the /docs/hosted-instances page with improved API and ENS deployment visibility.
Description check ✅ Passed The description follows the template with all required sections completed: Summary, Why, Testing, and Pre-Review Checklist all present and filled out.
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 docs/update-hosted-instances-page

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

@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: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 8220c38 and 7c3a8fb.

📒 Files selected for processing (4)
  • docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts
  • docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro
  • docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro
  • docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx

Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR updates the /docs/hosted-instances page to surface per-instance API details and ENS deployment information. The "Purpose" field is replaced with a structured "APIs" section (using named Astro slots), and new rows for "ENSNode Version" and "ENS Deployments" are added to each instance table.

  • HostedEnsNodeInstances.astro replaces the freeform purpose prop with three named slots (ens-omnigraph-api, ens-subgraph-api, ens-protocol-acceleration) and adds deployments and a hardcoded ensNodeVersion constant.
  • hosted-instances.mdx introduces reusable exported string constants for the API description copy and fills the new slots for all five hosted instances.
  • HostedInstanceSdkVersionWarning.astro adds a hyperlink to /docs/hosted-instances in the caution banner; sidebar topic labels in integrate.ts are made more concise.

Confidence Score: 5/5

Safe to merge — this is a documentation-only change with no logic that could affect application behaviour.

All changes are limited to MDX content, Astro template markup, and a sidebar label rename. The previously reported issues (misspelled variable name, leading whitespace, unused imports, spurious version dot, dead purpose prop) are resolved in the current revision. No new defects were found.

No files require special attention.

Important Files Changed

Filename Overview
docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Replaces purpose prop with named slots for three API descriptions; adds deployments prop and a hardcoded ensNodeVersion export. No functional issues found in the current state.
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Adds exported string constants for API descriptions and populates the new slots across all five instance usages. All previously flagged spelling/whitespace issues are resolved.
docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro Adds a hyperlink wrapping the 'Our hosted ENSNode instances' text. No unused imports remain; change is minimal and correct.
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts Sidebar label renames only ('ENSDb Integration Quickstart' → 'ENSDb (SQL)', 'ensdb-cli (Snapshots)' → 'ensdb-cli (ENSDb Snapshots)'). No issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    MDX["hosted-instances.mdx\n(exported string constants)"]
    HEI["HostedEnsNodeInstances.astro\n(table component)"]
    WARN["HostedInstanceSdkVersionWarning.astro\n(caution banner)"]

    MDX -->|instanceURL, namespace, deployments, plugins| HEI
    MDX -->|slot: ens-omnigraph-api| HEI
    MDX -->|slot: ens-subgraph-api| HEI
    MDX -->|slot: ens-protocol-acceleration| HEI
    MDX -->|for=both| WARN

    HEI --> ROW1["Hosted at (URL + ENSAdmin link)"]
    HEI --> ROW2["ENSNode Version (v1.13.1)"]
    HEI --> ROW3["ENS Namespace"]
    HEI --> ROW4["ENS Deployments"]
    HEI --> ROW5["Active Plugins"]
    HEI --> ROW6["APIs (dl with dt/dd per slot)"]

    WARN --> LINK["Link → /docs/hosted-instances"]
Loading

Reviews (2): Last reviewed commit: "Improve definition list styling" | Re-trigger Greptile

Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.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

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-instances to 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.

Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro Outdated
Comment thread docs/ensnode.io/src/components/molecules/HostedEnsNodeInstances.astro 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

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

Comment on lines +4 to +5
const { instanceURL, connectWithENSAdminURL, namespace, deployments, plugins } = Astro.props;
export const ensNodeVersion = "v1.13.1";
Comment on lines 26 to 28
<Aside type="caution" title="Version compatibility with hosted instances">
Our hosted ENSNode instances currently run ENSNode v1.13. If you are querying them from your own app, you <strong>must</strong> use <span set:html={sdkList} />. The latest published versions (<code>1.14.0+</code>) contain breaking changes in the Omnigraph API data model not yet deployed to our hosted infrastructure. Use these exact install commands:
<a href="/docs/hosted-instances">Our hosted ENSNode instances</a> currently run ENSNode v1.13. If you are querying them from your own app, you <strong>must</strong> use <span set:html={sdkList} />. The latest published versions (<code>1.14.0+</code>) contain breaking changes in the Omnigraph API data model not yet deployed to our hosted infrastructure. Use these exact install commands:

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