Skip to content

[WIP] Improve "Self-Hosting" content#2284

Draft
tk-o wants to merge 2 commits into
mainfrom
docs/improve-self-hosting-content
Draft

[WIP] Improve "Self-Hosting" content#2284
tk-o wants to merge 2 commits into
mainfrom
docs/improve-self-hosting-content

Conversation

@tk-o

@tk-o tk-o commented Jun 11, 2026

Copy link
Copy Markdown
Member

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • What changed (1-3 bullets, no essays).

Why

  • Why this change exists. Link to related GitHub issues where relevant.

Testing

  • How this was tested.
  • If you didn't test it, say why.

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 June 11, 2026 11:08
@changeset-bot

changeset-bot Bot commented Jun 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 95a9393

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

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
enskit-react-example.ensnode.io Ready Ready Preview, Comment Jun 11, 2026 11:59am
ensnode.io Ready Ready Preview, Comment Jun 11, 2026 11:59am
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped Jun 11, 2026 11:59am
ensrainbow.io Skipped Skipped Jun 11, 2026 11:59am

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@tk-o, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 11 minutes and 12 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, 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 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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6dc723ed-cf56-4cf4-8e56-2b48bd412ebc

📥 Commits

Reviewing files that changed from the base of the PR and between 95a9393 and 03d44dc.

📒 Files selected for processing (2)
  • docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
📝 Walkthrough

Walkthrough

Self-hosting documentation page restructured to present concrete capabilities as an enumerated benefits list and to consolidate deployment method options under a unified heading using card components instead of separate subsections.

Changes

Self-hosting documentation restructuring

Layer / File(s) Summary
Benefits enumeration and deployment options layout
docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
Benefits section rewritten from prose explanation into bullet-point list enumerating concrete self-hosting capabilities (ENS namespace and plugin selection, ENSRainbow name-healing customization, ENSDb indexing and data model control, versioning and update management, uptime strategies); deployment section condensed to use two LinkCard components for Docker and Terraform options under a single "Deployment options" heading.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • namehash/ensnode#2146: Self-hosting guide updated previously to add a "Massive scalability" subsection; this PR continues restructuring the same page.
  • namehash/ensnode#2107: Prior modification to the same self-hosting index page added ENSDb snapshots/CLI teaser section; this PR reformats other sections of the page.

Suggested labels

docs

Poem

🐰 Self-hosting truths now shine so bright,
Benefits listed, clear and tight,
Deployment cards in neat array,
Docs guide users the clearest way!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is entirely a template with all sections unfilled (Summary, Why, Testing, Notes, and Checklist are empty placeholders), failing to provide any concrete information about the changes, rationale, or testing approach. Fill in all required sections: provide 1-3 bullets summarizing changes, explain the rationale with issue links, describe testing approach, add optional reviewer notes, and check the pre-review checklist boxes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title uses [WIP] prefix and broadly refers to 'Improve "Self-Hosting" content', which aligns with the actual changes (updating self-hosting documentation), but is generic and doesn't convey the specific focus on highlighting benefits.
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/improve-self-hosting-content

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the “Self-host ENSNode” documentation page to better explain the practical benefits of self-hosting versus using publicly hosted instances, and to present deployment paths more clearly.

Changes:

  • Replaces the prior intro/note blocks with a more concrete benefits list (namespaces, plugins, ENSRainbow label sets, ENSDb readers/writers, etc.).
  • Reorganizes the deployment section into a single “Deployment options” area with richer LinkCard descriptions.

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

Comment thread docs/ensnode.io/src/content/docs/docs/self-host/index.mdx Outdated
Comment thread docs/ensnode.io/src/content/docs/docs/self-host/index.mdx Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 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/self-host/index.mdx`:
- Line 17: Replace the redundant phrase "your own strategies" in the sentence
"**Manage uptime**: apply your own strategies for ensuring high availability and
uptime guarantees." with a simpler wording such as "apply strategies for
ensuring high availability and uptime guarantees" so the line reads "**Manage
uptime**: apply strategies for ensuring high availability and uptime
guarantees."
- Around line 11-15: Fix the broken or unclear internal links and clean up the
minor wording repetition: verify and update the ENSRainbow anchor links in
index.mdx to use the exact heading slugs “#available-label-sets” and
“#how-ensrainbow-helps” (ensure the target headings in the ENSRainbow doc match
those slugs), confirm the ENSDb links point to the existing pages
(/docs/integrate/integration-options/ensdb, /ensdb-writers, /ensdb-readers) and
correct any path capitalization or trailing slashes, and simplify the duplicated
phrase on the subsequent line by removing the repeated “your own” to read
concisely (adjust the sentence near the “Manage uptime” line).
🪄 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: 918646ef-3773-424b-9aa5-7e669c587106

📥 Commits

Reviewing files that changed from the base of the PR and between 6fa2f2f and 95a9393.

📒 Files selected for processing (1)
  • docs/ensnode.io/src/content/docs/docs/self-host/index.mdx

Comment thread docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
Comment thread docs/ensnode.io/src/content/docs/docs/self-host/index.mdx Outdated
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