Skip to content

docs: update README and CODEBASE_MAP with new features, error classes…#58

Merged
weroperking merged 1 commit intoweroperking:mainfrom
Helal-maker:main
Mar 30, 2026
Merged

docs: update README and CODEBASE_MAP with new features, error classes…#58
weroperking merged 1 commit intoweroperking:mainfrom
Helal-maker:main

Conversation

@Helal-maker
Copy link
Copy Markdown
Contributor

@Helal-maker Helal-maker commented Mar 30, 2026

…, and documentation structure

Summary by CodeRabbit

Release Notes

  • Documentation
    • Restructured and expanded README with new IaC-focused Quick Start workflow, feature overview, and deployment guidance.
    • Added Betterbase vs Convex comparison and Inngest integration sections.
    • Enhanced authentication setup documentation with provider configuration examples.
    • Improved contribution and development guidelines with project structure and commit conventions.
    • Updated codebase map with expanded routing and module documentation.

@weroperking weroperking merged commit 748f225 into weroperking:main Mar 30, 2026
3 of 4 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 44b85bd6-f470-4343-be8b-0f897bf648f3

📥 Commits

Reviewing files that changed from the base of the PR and between b8bacf4 and 3ebfdf2.

📒 Files selected for processing (2)
  • CODEBASE_MAP.md
  • README.md

Walkthrough

CODEBASE_MAP.md restructured to document new IaC modules (errors.ts), client provider exports, expanded template sections, and dashboard routing map. README.md substantially rewritten with new branding, IaC-focused quick start workflow, feature enumeration, deployment provider guidance, authentication setup, and contribution guidelines.

Changes

Cohort / File(s) Summary
Documentation Structure
CODEBASE_MAP.md
Removed "Canonical Orientation Files" section; added errors.ts to IaC module table; expanded dashboard routing map with setup/auth/project-scoped routes; added UI components/hooks/layouts/docs directory mappings; introduced templates/iac/ template section; updated "recent updates" (2026-03-30) with IaC errors/generators and docs directory content.
Primary README Rewrite
README.md
Replaced enterprise positioning with DeepWiki branding and hero section; reformatted Quick Start around IaC workflow (bb init, bb dev); added "Why Choose Betterbase" comparison tables; expanded feature section (IaC, realtime, SQL, search, functions, storage, webhooks, jobs, RLS, branching); added Betterbase vs Convex comparison; included Inngest integration details; expanded deployment (local/docker/self-hosted) and database provider configuration (neon, turso, mysql, planetscale); added authentication setup with RLS policy examples; included "Ask Deepwiki" context generation section; expanded contribution/development guidance (structure, Biome, testing, commit conventions).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • PR #13: Both modify CODEBASE_MAP.md and expand documented template/public exports for IaC and other modules.
  • PR #46: Both add IaC entries to CODEBASE_MAP and document corresponding client/core IaC files (errors.ts, provider.tsx).
  • PR #38: Both expand repository documentation and add structured docs/ directory mappings to CODEBASE_MAP.md.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants