[WIP] Improve "Self-Hosting" content#2284
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR restructures the ENSNode self-hosting documentation by rewriting the index page, introducing new Deployment Options and Operations sections with Railway support, reorganizing sidebar navigation, adding URL redirects, and cleaning up frontmatter metadata. ChangesSelf-hosting documentation restructuring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
🚥 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 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.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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
tk-o
force-pushed
the
docs/improve-self-hosting-content
branch
from
1f564d3 to
9332938
Compare
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
tk-o
force-pushed
the
docs/improve-self-hosting-content
branch
from
9332938 to
cf7f980
Compare
|
@greptile review |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
tk-o
force-pushed
the
docs/improve-self-hosting-content
branch
from
8e17e8f to
7b0125e
Compare
| @@ -0,0 +1,13 @@ | |||
| --- | |||
There was a problem hiding this comment.
The railway.mdx file is missing the sidebar frontmatter with a label property, causing inconsistency with docker.mdx and terraform.mdx
|
|
||
| Operating an ENSNode deployment requires understanding the critical workloads that ENSNode is responsible for, as well as the best practices for managing and optimizing these workloads, including monitoring, scaling, and resource management. This section provides an overview of the key operational considerations for running your own ENSNode instance effectively. | ||
|
|
||
| ### Next steps |
| ## ENSv1 + ENSv2 Instances | ||
|
|
||
| These instances are associated with an ENS namespace that has upgraded to ENSv1 + ENSv2 and demonstrate the latest support in ENSNode for ENSv1 and ENSv2 being concurrently activated together. | ||
|
|
||
| #### ENSNode 'v2 Sepolia' | ||
| ### ENSNode 'v2 Sepolia' |
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)