Add minimum and recommended system requirements to local setup guide (#553) - #576
Add minimum and recommended system requirements to local setup guide (#553)#576ruchiralakshan123 wants to merge 3 commits into
Conversation
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe local setup documentation adds a “System requirements” section with minimum and recommended requirements for operating system, CPU, RAM, disk space, and network access. ChangesLocal setup requirements
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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.
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 `@en/docs/get-started/setup/local-setup.md`:
- Line 21: Update the Network requirement in the local setup prerequisites to
require internet only for installation and dependency downloads; remove WSO2
Cloud connectivity as a minimum prerequisite while preserving the existing
broadband recommendation.
- Line 17: Update the operating-system support row in the local setup
requirements table to include Fedora alongside the existing Linux distributions,
matching the RHEL/Fedora RPM installation instructions. Keep the macOS and
Windows requirements unchanged.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d1b18288-feeb-4050-8146-f35ec6566adc
📒 Files selected for processing (1)
en/docs/get-started/setup/local-setup.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@en/docs/get-started/setup/local-setup.md`:
- Line 20: Add blank lines immediately before and after the requirements table
in the setup documentation, preserving the table content and formatting while
satisfying Markdownlint MD058.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5d0626af-5802-4bc8-89e9-3079b3ad198f
📒 Files selected for processing (1)
en/docs/get-started/setup/local-setup.md
Purpose
Resolves #553
Goals
Specify the minimum and recommended system requirements in the local setup documentation to help users validate their environments before installation.
Approach
Added a new "System requirements" section with a comparison table (detailing OS, CPU, RAM, Disk Space, and Network specifications) to
en/docs/get-started/setup/local-setup.md.User stories
N/A
Release note
Add minimum and recommended system requirements to local setup guide.
Documentation
N/A (This is a documentation-only fix)
Training
N/A
Certification
N/A
Marketing
N/A
Automation tests
N/A
N/A
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
Verified markdown formatting locally.
Learning
N/A
Summary by CodeRabbit