[ENGG-5080] chore: Updated the structure of the readme.

[rdsharma3333]

README.md Improvements
Grammar & Wording Fixes
Changed "Debug your network request" to "Debug your network requests" (plural form)
Added article "a" to "You should have a web app server running locally"
Replaced ampersands (&) with "and" for better readability
Changed "Locally" to lowercase "locally" for consistency
Fixed capitalization: "start watching" → "Start watching"
Formatting & Structure Enhancements
Converted nested steps under item 4 (requestly-proxy setup) from inconsistent numbering (1-3) to properly formatted sub-steps (a, b, c)
Improved parenthetical note formatting for better readability
Added colon after section descriptions for consistency
Added sh language specifier to the Packaging code block for consistency with other code blocks
Punctuation & Clarity
Added missing period after "Follow this [step]" link
Changed "then follow the following steps" to "follow these steps:" (clearer, less repetitive)
Improved note formatting: "Press" → "press" for consistency with surrounding text
All changes maintain the original intent and structure while improving readability, consistency, and professional presentation of the documentation.

Summary by CodeRabbit

• Documentation
  • Updated Node.js minimum version requirement to 18.18.0
  • Reorganized and simplified development/setup flow with clearer install & start steps
  • Consolidated proxy/run/watch guidance into a stepwise, platform-aware sequence
  • Clarified packaging instructions (use npm run package) and reformatted presentation
  • Improved wording, capitalization, and overall consistency throughout docs

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

The README.md was edited to pluralize the main heading, adjust capitalization and phrasing in prerequisites, bump the Node.js requirement from 16.15.0 to 18.18.0 (NPM version unchanged), and substantially reorganize the Development/Run/Setup flow. The prior top-level cloning of requestly-proxy was removed and replaced with a simplified local npm install/start sequence, while an expanded optional section describes cloning and running requestly-proxy with platform-specific watch instructions. The Packaging section was updated to show npm run package in a fenced code block. No public/exported API changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Changes are documentation-only but involve substantial reorganization and multiple sections.
• Areas needing focused review:
  • Node.js version bump and any associated commands or examples relying on Node behavior.
  • Reworked Development/Run/Proxy watch sequence for clarity and platform-specific guidance.
  • Packaging command formatting and any surrounding instructions that reference it.
  • Consistency across README sections after reordering (links, step numbering, and prerequisites).

Suggested reviewers

• RuntimeTerror10
• nafees87n

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title accurately captures the main change of restructuring and improving the README documentation with better grammar, formatting, and organization.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch RQ-000_UpdateReadme

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 941be5d and 4e7a847.

⛔ Files ignored due to path filters (1)

• release/app/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (3)

README.md (3)

47-48: Verify Node.js version bump and update npm version guidance.

The Node.js version bump from 16.15.0 to 18.18.0 is a breaking change for users on Node 16. While 18.18.0 is a reasonable modern LTS, ensure this version constraint is intentional and necessary for the codebase.

Additionally, npm 8.5.5 (from 2022) is significantly outdated. Current npm versions are 10+. Consider either updating the npm version requirement to align with modern releases or removing the constraint if it's not critical.

---

50-50: Verify external documentation link.

The link to requestly/requestly repo's README should be validated to ensure it remains accessible and points to the correct resource.

Please confirm the link is valid and points to the current proxy setup documentation.

---

28-28: Excellent structural and clarity improvements.

The grammar fixes ("network requests" plural, proper articles, consistent capitalization), section reorganization, and conversion of nested steps to sub-steps (a, b, c) substantially improve documentation readability and consistency. The proxy setup instructions are now explicit and well-formatted with proper code fencing.

Also applies to: 45-45, 53-101

[linear]

ENGG-5080 Rohit Onboarding