Skip to content

docs: rewrite root README to enterprise-grade structure#56

Merged
weroperking merged 1 commit intomainfrom
codex/rewrite-readme-for-comprehensive-enterprise-style-re38iq
Mar 30, 2026
Merged

docs: rewrite root README to enterprise-grade structure#56
weroperking merged 1 commit intomainfrom
codex/rewrite-readme-for-comprehensive-enterprise-style-re38iq

Conversation

@weroperking
Copy link
Copy Markdown
Owner

Motivation

  • Replace the fragmented, community-oriented README with a concise, enterprise-grade landing document that clearly communicates product positioning, governance expectations, and practical onboarding for platform and product engineering teams.
  • Improve navigation to core docs and make deployment and operating guidance prominent for self-hosted and production adoption.

Description

  • Rewrote the root README.md end-to-end to introduce an Executive 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 streamlined Development and Contribution section.
  • Removed large ASCII-art header and consolidated Deepwiki-specific badge/content into a compact header linking to docs, self-hosting, contributing, and notice files.
  • Added succinct sample IaC schema and typical project layout examples, and replaced scattered feature tables with a focused capabilities and deployment narrative.
  • Updated internal links to existing docs (e.g., docs/README.md, SELF_HOSTED.md, CONTRIBUTING.md, NOTICE.md) and kept developer commands (bb init, bb dev, bun install) for quick onboarding.

Testing

  • Verified the file diff and staged/committed the change using git add README.md and git commit, which succeeded.
  • Attempted to run linting via bun run lint, which failed in the current environment with turbo: command not found (dependencies not installed), so automated lint/test suite could not be executed here.
  • Performed local file inspections (viewing the new README.md) to confirm formatting and link references.

Codex Task

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

Warning

Rate limit exceeded

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

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 6 minutes and 22 seconds.

⌛ 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5eb71f6c-d74b-48ae-8499-56c002c79018

📥 Commits

Reviewing files that changed from the base of the PR and between de23ac3 and c2d301e.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/rewrite-readme-for-comprehensive-enterprise-style-re38iq

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

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

@weroperking weroperking merged commit 82a09f4 into main Mar 30, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant