Skip to content

Improve hosted instances docs#2196

Merged
lightwalker-eth merged 4 commits into
mainfrom
docs/hosted-instances-page-improvements
May 25, 2026
Merged

Improve hosted instances docs#2196
lightwalker-eth merged 4 commits into
mainfrom
docs/hosted-instances-page-improvements

Conversation

@tk-o
Copy link
Copy Markdown
Member

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

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • Dropped specific plugin name references to keep the idea of API-level Subgraph compatibility shared in docs among multiple different hosted instances of ENSIndexer.
  • Added cross-links for improved docs navigation.

Why


Testing

  • Ran the ENSNode docs website locally and verified updates visually.

Notes for Reviewer (Optional)


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

changeset-bot Bot commented May 25, 2026

⚠️ No Changeset found

Latest commit: 5b84d7e

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 25, 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 25, 2026 10:36pm
enskit-react-example.ensnode.io Ready Ready Preview, Comment May 25, 2026 10:36pm
ensnode.io Ready Ready Preview, Comment May 25, 2026 10:36pm
ensrainbow.io Ready Ready Preview, Comment May 25, 2026 10:36pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 25, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5b1549a8-7144-44f0-8c03-fb231d5d3d32

📥 Commits

Reviewing files that changed from the base of the PR and between 39cb445 and 5b84d7e.

📒 Files selected for processing (1)
  • docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx

📝 Walkthrough

Walkthrough

This PR updates the hosted-instances.mdx documentation file with three localized copy and formatting revisions: exported string constants for ENS compatibility descriptions, the sepolia-v2 instance example plugin list, and descriptive prose about ENSv1 and Alpha-style deployments, adjusting emphasis and link markup throughout.

Changes

Hosted Instances Documentation Updates

Layer / File(s) Summary
Documentation copy and markup updates
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
Exported compatibility/omnigraph string constants revised with updated NOTE emphasis, removed parenthetical list from API-level text, and added <em>Activated.</em> prefix to ENSv1+ENSv2 omnigraph description. The sepolia-v2 instance example plugins prop updated to use <em>...</em>-wrapped names. Prose sections describing "ENSv1 Only Instances" and "Alpha-style Deployments" updated with emphasized "NOT" text and reformatted link/emphasis markup for API references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • namehash/ensnode#2099: Both PRs update the same docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx file, especially ENSv1/ENSv2 compatibility copy and hosted instance plugins example formatting.
  • namehash/ensnode#2173: Both PRs modify the same docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx file, adjusting exported API compatibility string constants and instance example props.

Poem

🐰 A rabbit hops through markdown trails,
Polishing words with whisker-ed detail,
Emphasis here, a link there too,
ENS omnigraph shines brand-new! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Improve hosted instances docs' is vague and generic, using non-descriptive language that doesn't convey specific information about what was actually changed. Consider a more specific title like 'Update hosted instances documentation for API-level compatibility clarity' to better reflect the substantive changes made.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The PR description follows the required template structure with all sections present: Summary, Why, Testing, Notes for Reviewer, and Pre-Review Checklist. All required information is provided.
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/hosted-instances-page-improvements

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 hosted instances documentation to keep “Subgraph compatibility” descriptions more general (not tied to specific plugins) and to improve navigation by cross-linking to relevant integration and services docs.

Changes:

  • Removed specific plugin-name examples from the “API-level Subgraph Compatibility” blurb while keeping the core compatibility caveat.
  • Replaced Markdown **NOTE:** inside set:html strings with proper HTML emphasis to render correctly.
  • Added internal cross-links to Omnigraph, enssdk, enskit, and Services docs for easier discovery.

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

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 25, 2026

Greptile Summary

This PR makes targeted improvements to the hosted instances documentation page. It removes specific plugin name references (Basenames, Lineanames, 3DNS) from the API-level subgraph compatibility description to keep it applicable across multiple hosted instances, normalizes **NOTE:** markdown bold syntax to <em>NOTE:</em> HTML (which is appropriate since these strings are rendered via set:html), adds an <em>Activated.</em> prefix to the omnigraphForEnsV1AndEnsV2 variable for consistency with other status strings, and adds cross-links to related documentation pages.

  • Removed specific plugin names from subgraphCompatibilityApiLevel to make it reusable across instances with different plugin configurations.
  • Added hyperlinks to /docs/integrate/omnigraph, /docs/integrate/integration-options/enssdk, /docs/integrate/integration-options/enskit, and /docs/services in the ENSv1-only instances section for better navigation.
  • Reformatted the sepolia-v2 plugins prop to use <em> tags consistent with other instances, and aligned omnigraphForEnsV1AndEnsV2 to start with <em>Activated.</em> like its sibling status strings.

Confidence Score: 5/5

This is a documentation-only change with no runtime code impact; all internal cross-links resolve to existing files.

The change touches a single MDX file, makes copy/formatting improvements, and adds cross-links whose target pages were verified to exist in the repository. The NOTE:NOTE: fix is actually a correctness improvement since these strings are rendered via Astro's set:html and markdown syntax would not be processed there.

No files require special attention.

Important Files Changed

Filename Overview
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx Documentation-only update: removes specific plugin name references from compatibility descriptions, adds cross-links, and normalizes NOTE formatting from markdown bold to HTML italic. All linked paths verified to exist. Consistent with existing formatting patterns in the file.

Reviews (4): Last reviewed commit: "Merge branch 'main' into docs/hosted-ins..." | Re-trigger Greptile

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 1 changed files in this pull request and generated no new comments.

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.

@tk-o Thanks for updates 👍

@lightwalker-eth lightwalker-eth merged commit 08b84cd into main May 25, 2026
20 checks passed
@lightwalker-eth lightwalker-eth deleted the docs/hosted-instances-page-improvements branch May 25, 2026 22:40
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