Skip to content

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

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

[WIP] Improve "Self-Hosting" content#2284
tk-o wants to merge 3 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

  • Refined the overview page for the "Self-host" section
  • Updated guides for deployment options
    • Added a guide for deploying ENSNode Alpha instance to Railway

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

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 8:02pm
ensnode.io Ready Ready Preview, Comment Jun 11, 2026 8:02pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped Jun 11, 2026 8:02pm
ensrainbow.io Skipped Skipped Jun 11, 2026 8:02pm

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

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: e924a503-5807-43f8-9f12-70dad40c96cb

📥 Commits

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

📒 Files selected for processing (7)
  • docs/ensnode.io/config/integrations/starlight/sidebar-topics/self-host.ts
  • docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/docker.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/railway.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/scalability.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/terraform.mdx
💤 Files with no reviewable changes (3)
  • docs/ensnode.io/src/content/docs/docs/self-host/terraform.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/scalability.mdx
  • docs/ensnode.io/src/content/docs/docs/self-host/docker.mdx

📝 Walkthrough

Walkthrough

Self-hosting docs: rewritten intro listing concrete capabilities, deployment options consolidated into a single "Deployment options" block with LinkCards (Docker, Railway, Terraform), a new Railway deploy page added, sidebar navigation grouped, hosted-instances heading promoted, and sidebar frontmatter order fields removed from several pages.

Changes

Self-hosting & docs housekeeping

Layer / File(s) Summary
Benefits enumeration and deployment options
docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
Intro rewritten from prose to a bullet list enumerating self-hosting capabilities; deployment subsections consolidated into a single "Deployment options" block with LinkCards for Docker, Railway, and Terraform.
Sidebar grouping: Deployment options
docs/ensnode.io/config/integrations/starlight/sidebar-topics/self-host.ts
selfHostSidebarTopic.items restructured to add a "Deployment options" group and nest Docker and Terraform under it, adding Railway to the group.
Add Railway deploy page
docs/ensnode.io/src/content/docs/docs/self-host/railway.mdx
New MDX page added that imports LinkCard and renders a LinkCard to the ENSNode Railway template deploy URL.
Hosted-instances heading promotion
docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx
Inserted the "ENSv1 + ENSv2 Instances" heading so the ENSNode 'v2 Sepolia' subsection is grouped under it.
Frontmatter cleanup (order removal)
docs/ensnode.io/src/content/docs/docs/self-host/docker.mdx, .../scalability.mdx, .../terraform.mdx
Removed sidebar.order / order fields from self-host Docker, Scalability, and Terraform pages' frontmatter; labels and page contents unchanged.

Sequence Diagram(s)

sequenceDiagram
  participant Editor
  participant index.mdx
  participant sidebar-topics/self-host.ts
  participant railway.mdx
  Editor->>index.mdx: update intro & deployment LinkCards
  index.mdx->>sidebar-topics/self-host.ts: require grouped "Deployment options"
  Editor->>railway.mdx: add Railway deploy page with LinkCard
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

docs

Poem

🐰 I hopped through docs with a joyful cheer,
Listed hosting perks so they're clear,
Cards for Docker, Railway, Terraform too,
Sidebar neat and headings true—hooray, anew!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description follows the required template structure but is incomplete: the 'Why' section is blank, 'Testing' section is blank, and the 'Pre-Review Checklist' items are unchecked with no explanation. Complete the 'Why' section with rationale and related GitHub issues, fill in 'Testing' details explaining how changes were tested, and address the blocking checklist items.
Title check ❓ Inconclusive The title '[WIP] Improve "Self-Hosting" content' is vague and generic, using broad terms like 'Improve' without clearly specifying the main changes. Replace with a more specific title that highlights key changes, such as '[WIP] Add Railway deployment guide and reorganize self-hosting docs' or '[WIP] Reorganize self-hosting deployment options with Railway support'.
✅ Passed checks (3 passed)
Check name Status Explanation
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 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

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

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

@@ -0,0 +1,13 @@
---

@vercel vercel Bot Jun 11, 2026

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.

The railway.mdx file and other deployment option files are missing required order property in sidebar frontmatter, preventing the Astro Starlight sidebar-topics plugin from properly ordering pages

Fix on Vercel

@tk-o tk-o force-pushed the docs/improve-self-hosting-content branch from 9332938 to cf7f980 Compare June 11, 2026 20:00
@vercel vercel Bot temporarily deployed to Preview – admin.ensnode.io June 11, 2026 20:00 Inactive
@vercel vercel Bot temporarily deployed to Preview – ensrainbow.io June 11, 2026 20:00 Inactive
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