chore(docs): add RPC requirements for low-traffic nodes#6997
Merged
hanabi1224 merged 4 commits intomainfrom May 4, 2026
Merged
chore(docs): add RPC requirements for low-traffic nodes#6997hanabi1224 merged 4 commits intomainfrom
hanabi1224 merged 4 commits intomainfrom
Conversation
LesnyRumcajs
force-pushed
the
add-min-rpc-reqs
branch
from
8a4307a to
3ce4f01
Compare
Contributor
WalkthroughReorganized and expanded the hardware requirements docs for Forest RPC nodes: added an upfront RPC disk-sizing rule-of-thumb (example for 60 days, updated "disable GC" growth), introduced "RPC Node (low traffic, minimal retention)" and "RPC Node (2 months retention)" sections with CPU/memory/disk tables, moved Bootstrap Node section, and replaced a Twitter iframe with a direct link. ChangesHardware Requirements — RPC & Bootstrap docs
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Review rate limit: 4/5 reviews remaining, refill in 12 minutes. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/users/getting_started/hardware-reqs.md`:
- Line 44: The sentence contains a duplicated word "need need"; update the
string "might need need to tweak the setup." to "might need to tweak the setup."
by removing the extra "need" so the user-facing sentence reads correctly; search
for the exact phrase to locate and edit the line in
docs/users/getting_started/hardware-reqs.md.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: e071a23c-9460-4ff5-8d71-e4727d25ba11
📒 Files selected for processing (1)
docs/docs/users/getting_started/hardware-reqs.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/docs/users/getting_started/hardware-reqs.md (1)
44-45: ⚡ Quick winClarify that retention also limits historical RPC availability.
This section explains sizing well, but it may still imply broad RPC coverage. Add a short note that requests for data older than the retention window may not be available.
Suggested patch
-This setup should be sufficient for a self-hosted RPC node that serves a small number of requests (under 100 requests per minute) and retains 2 months of historical state. Note that if the methods called by the clients are more resource-intensive, you might need to tweak the setup. +This setup should be sufficient for a self-hosted RPC node that serves a small number of requests (under 100 requests per minute) and retains 2 months of historical state. Requests that require data older than the retention window may be unavailable. Note that if the methods called by the clients are more resource-intensive, you might need to tweak the setup.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/users/getting_started/hardware-reqs.md` around lines 44 - 45, Update the paragraph that begins "This setup should be sufficient for a self-hosted RPC node that serves a small number of requests..." to append a short clarifying note that retention directly limits historical RPC availability — e.g., add one sentence stating requests for data older than the configured retention window may not be available and clients should plan accordingly; edit the same stanza in hardware-reqs.md so the clarification appears alongside the existing sizing guidance.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/docs/users/getting_started/hardware-reqs.md`:
- Around line 44-45: Update the paragraph that begins "This setup should be
sufficient for a self-hosted RPC node that serves a small number of requests..."
to append a short clarifying note that retention directly limits historical RPC
availability — e.g., add one sentence stating requests for data older than the
configured retention window may not be available and clients should plan
accordingly; edit the same stanza in hardware-reqs.md so the clarification
appears alongside the existing sizing guidance.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: ecdc3b8b-fbb2-4490-aaba-098053b02da0
📒 Files selected for processing (1)
docs/docs/users/getting_started/hardware-reqs.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/users/getting_started/hardware-reqs.md`:
- Line 46: The sentence "More of a curiosity - [direct Twitter
link](https://platform.twitter.com/embed/Tweet.html?id=1937542522387026383)"
claims the embed was replaced but the iframe embed remains below; either remove
the iframe embed block that references the same Tweet or update that sentence to
accurately state that the Tweet is embedded (e.g., change "direct Twitter link"
to "embedded Tweet" or similar). Locate and edit the sentence text and the
corresponding iframe embed in the same document (hardware-reqs.md) so the
wording and the actual page behavior match.
- Around line 8-10: Split the disk-sizing guidance into two explicit models: (1)
a "retention-based sizing" model referencing the phrase "200 GiB + 5 GiB per day
of retention" and the example calculation "200 GiB + (5 GiB * 60) = 500 GiB";
and (2) a "GC-disabled growth" model referencing the sentence that starts with
"Also, if you disable GC" and the "~2 GiB per day" growth rate. For each model,
state the assumptions, the applicable formula or ongoing growth rate, and an
operator action (e.g., manual disk monitoring/cleanup for GC-disabled), making
clear they are mutually exclusive so readers do not combine "5 GiB/day" and "~2
GiB/day" in one calculation.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: e9bcf6b4-e656-48fc-b721-afb4007223cc
📒 Files selected for processing (1)
docs/docs/users/getting_started/hardware-reqs.md
hanabi1224
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
Changes introduced in this pull request:
Reference issue to close (if applicable)
Closes
Other information and links
Change checklist
Outside contributions
Summary by CodeRabbit