chore: rewrite outdated parts of the README

[Avni2000]

• link to the docs site in a number of places
• working on update README, videos, images, and docs #184

Summary by CodeRabbit

• Documentation
  • README reorganized with a shorter hero section and consolidated Features list for clarity
  • Installation and Quick start sections streamlined for easier navigation
  • Configuration guidance simplified with links to detailed documentation
  • Development section condensed to reference architecture and testing resources

[coderabbitai]

Warning

Rate limit exceeded

@Avni2000 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 26 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ab192162-80ec-439e-9f3c-806ef0361cf7

📥 Commits

Reviewing files that changed from the base of the PR and between 15d3b01 and 600b8ad.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

README.md is reorganized from a lengthy, feature-narrative structure into a compact, link-driven layout. The hero section, Features list, and introductory content are condensed; Quick start and Configuration sections are simplified with external documentation links; and Development guidance is refactored to point to dedicated docs instead of embedding command snippets.

Changes

README Documentation Reorganization

Layer / File(s)	Summary
README structure and content refresh README.md	Hero introduction, Features list, and Documentation/Installation/Quick start sections are condensed. Quick start steps and Configuration are consolidated into a single docs link. Development section is simplified to link to architecture and testing docs instead of embedding local command details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

---

🐇 A README once long and winding now sparkles bright and kind,
With features gleaming, docs aligned, and links to guide your mind.
We hopped through prose and trimmed away the clutter and the noise—
Now quickstart readers, happy souls, will find their developer joys! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: rewrite outdated parts of the README' directly and accurately describes the main change in the pull request—reorganizing and rewriting the README content.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch readme-rewrite

---

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

🤖 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 `@README.md`:
- Line 33: Replace the non-descriptive link text "here" with descriptive wording
for accessibility and clarity: change the Markdown link "**Find the docs site
[here](https://avni2000.github.io/MergeNB/docs)**" so the link text describes
the destination (for example "**Find the MergeNB documentation site**" or
"**MergeNB docs site**") while keeping the URL the same; update the text in
README.md where that link appears so screen readers and readers scanning the
file see a meaningful link label.

🪄 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: c0f6f4a1-d16c-4ad3-9998-80a17f5699d2

📥 Commits

Reviewing files that changed from the base of the PR and between 6071d2b and 15d3b01.

📒 Files selected for processing (1)

• README.md

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud