docs: improve README with clearer project overview and documentation structure

[aryansondharva]

Summary

This PR improves the main README.md by making it cleaner, more professional, and easier for new contributors to understand.

Changes

• Added a clear project overview
• Improved repository structure section
• Added descriptions for each documentation directory
• Simplified the Getting Started guide
• Improved readability and organization
• Enhanced documentation for first-time contributors
• Used a cleaner Markdown structure for better navigation

Why

The previous README was highly detailed but difficult for new users to quickly understand. This update focuses on improving the developer experience by making the documentation more approachable while keeping the essential information easy to find.

Type of Change

• Documentation improvement
• Bug fix
• New feature
• Breaking change

Checklist

• README updated
• Documentation reviewed
• No code changes
• Markdown formatting verified

Summary by CodeRabbit

• Documentation
  • Replaced the README with a concise documentation landing page.
  • Added overviews of available capabilities, repository structure, and documentation areas.
  • Added getting-started instructions for cloning the repository and navigating to relevant folders.
  • Added guidance for intended audiences, contribution information, and MIT licensing details.

[coderabbitai]

Warning

Review limit reached

@aryansondharva, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1494a28c-79b2-49b0-942a-e95ee966e4fa

📥 Commits

Reviewing files that changed from the base of the PR and between e7da783 and a6b9461.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

Changes

README documentation

Layer / File(s)	Summary
Project overview and documentation topics README.md	Adds an Open Paws introduction and sections for Knowledge, Predictions, Generation, Automation, and Infrastructure.
Repository structure and getting started README.md	Documents the repository layout, cloning commands, directory purposes, and intended audiences.
Contribution and license information README.md	Updates contribution guidance and adds the MIT license statement referencing LICENSE.

Estimated code review effort: 2 (Simple) | ~10 minutes

---

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name	Status	Explanation	Resolution
No Hardcoded Secrets Or Credentials	❌ Error	Knowledge/README.md contains a hardcoded ReadOnly API Key on line 12.	Replace the embedded key with a placeholder or env-var example, and keep any historical allowlist entries only in .gitleaksignore.

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the README-focused documentation update and its emphasis on project overview and structure.
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.
No Speciesist Idioms	✅ Passed	README has no banned idioms; broader markdown scan found no whitelist/blacklist, master/slave, or similar terms.

✨ Finishing Touches

• 🛠️ fix NAV violations

---

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.}

[Copilot]

Pull request overview

This PR rewrites the top-level README.md to provide a shorter, more structured entry point intended to be easier for new contributors to scan and navigate within this pure-Markdown documentation repository.

Changes:

• Replaced the previous README content with a cleaner overview and section-based layout.
• Added high-level descriptions of major documentation areas (Knowledge, Predictions, Generation, Automation, Infrastructure).
• Added a simplified repository structure + getting-started snippet.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[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`:
- Around line 148-158: Replace the fenced CONTRIBUTING.md filename in the
README’s Contributing section with an inline Markdown link, such as “See
[CONTRIBUTING.md](CONTRIBUTING.md).”, removing the standalone code fence.

🪄 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: ASSERTIVE

Plan: Pro

Run ID: 0fc6fda4-b508-4a91-a0a6-9913e7de3489

📥 Commits

Reviewing files that changed from the base of the PR and between 648e104 and e7da783.

📒 Files selected for processing (1)

• README.md

[aryansondharva]

@samtuckerdavis @claude