[WIP] Improve "Self-Hosting" content#2284
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (7)
💤 Files with no reviewable changes (3)
📝 WalkthroughWalkthroughSelf-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. ChangesSelf-hosting & docs housekeeping
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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
docs/ensnode.io/src/content/docs/docs/self-host/index.mdx
1f564d3 to
9332938
Compare
| @@ -0,0 +1,13 @@ | |||
| --- | |||
9332938 to
cf7f980
Compare
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)