docs: rewrite root README to enterprise-grade structure#55
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 7 minutes and 0 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ 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 |
Motivation
Description
README.mdend-to-end to introduce anExecutive Summary,Who Betterbase Is For,Core Capabilities,Architecture at a Glance,Quick Start (IaC Workflow),Enterprise Operating Model,Documentation Map,Deployment Modes,Repository Structure, and a streamlinedDevelopment and Contributionsection.docs/README.md,SELF_HOSTED.md,CONTRIBUTING.md,NOTICE.md) and kept developer commands (bb init,bb dev,bun install) for quick onboarding.Testing
git add README.mdandgit commit, which succeeded.bun run lint, which failed in the current environment withturbo: command not found(dependencies not installed), so automated lint/test suite could not be executed here.README.md) to confirm formatting and link references.Codex Task