Update README and docs: fix stale SQLite/NextAuth references, sync structure - #59
Conversation
…ructure The database has been Postgres (via @prisma/adapter-neon) since the B-04 audit fix, but README.md, AGENTS.md, and several docs/ files still described SQLite as current — including a literal `provider = "sqlite"` schema snippet and `file:./dev.db` env examples that would produce a broken setup if followed today. Fixed all current-state references (left docs/AUDIT-FOLLOWUPS.md's historical finding and docs/HANDOFF.md's dated 2026-07-20 snapshot alone, since both are accurate records of a specific point in time, not claims about the app today). Also fixed the env var names to match .env.example / src/lib/auth.ts (AUTH_SECRET, not NEXTAUTH_SECRET/NEXTAUTH_URL — this repo runs NextAuth v5's Auth.js env var convention and doesn't need a URL var at all). Other fixes: - README's project structure tree still showed core/ as a flat 3-file module and CreateCampaignWizard.tsx as a top-level file; updated to match the real core/engine + core/slices split and the wizard/ subdirectory with per-ad-type steps. - README's Tech Stack table was missing Astryx (153 components, actively used across ~40 files) entirely. - README's pre-built-campaign table listed campaign #3's targeting mode as "Video creative" — that's the ad format, not targetingMode (which is actually 'Keyword'); corrected. - README claimed "8 slices" for the Zustand store; it's 8 core slices + 7 feature slices (15 total), per CLAUDE.md. - docs/TECH-SPECS.md's file-statistics table was stale in both directory shape and line counts (e.g. citing a single 600-line engine.ts that hasn't existed since the engine/ split); refreshed with real counts and dated the snapshot so future staleness is at least self-documenting. - Linked the new CHANGELOG.md and existing-but-unlinked docs/DEPLOYMENT.md from README's Documentation section. - CLAUDE.md: documented the new .claude/.agents/.codex ECC bundle (PR #56) and flagged that its auto-generated skill file contains at least one inaccurate claim (invented camelCase filename examples that don't match this repo's real PascalCase-components / lowercase-engine-modules convention) — CLAUDE.md remains the authoritative source when they disagree.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
|
Warning Review limit reached
Next review available in: 52 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughDocumentation now describes Prisma 7 with Postgres through the Neon adapter, updated authentication variables, current project structure, deployment links, and agent-tooling guidance. ChangesDocumentation refresh
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
There was a problem hiding this comment.
🟢 Ready to approve
The changes are documentation-only and largely verified against the repo, with only a minor README structure-sync nit remaining.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Updates repository documentation to reflect the current production reality (Postgres via Prisma Neon adapter + NextAuth v5/Auth.js env conventions) and to realign README/docs with the actual codebase structure and tooling.
Changes:
- Replaces stale SQLite /
NEXTAUTH_*setup guidance with Postgres +AUTH_SECRETconventions across README and docs. - Refreshes README structure/stack descriptions (engine split, wizard folder, Astryx components, slice counts) and links to additional docs.
- Updates
docs/TECH-SPECS.mdwith a dated file-statistics snapshot and modern Prisma driver-adapter notes.
File summaries
| File | Description |
|---|---|
| README.md | Corrects onboarding/architecture claims (stack, structure, docs links) to match current codebase reality. |
| docs/TECH-SPECS.md | Updates Prisma provider/env guidance and refreshes file-statistics snapshot with clearer context. |
| docs/FEATURES.md | Updates auth feature section to reflect Postgres via @prisma/adapter-neon. |
| docs/AUTH.md | Updates auth + env var documentation to current Auth.js conventions and Postgres-only reality. |
| docs/ARCHITECTURE.md | Updates server-side data flow + env vars to match Prisma Neon adapter + Postgres. |
| CLAUDE.md | Documents ECC bundle presence and clarifies authoritative guidance vs generated skill claims. |
| AGENTS.md | Updates stack summary (Postgres via Neon; Astryx/tokens styling) to match current repo setup. |
Review details
- Files reviewed: 7/7 changed files
- Comments generated: 1
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Copilot review flagged that these two backward-compat re-export files (export * from './core/types' / './core/scenarios') were dropped when the tree was resynced — they still exist and are real navigation points, unlike the engine.ts single-file that was correctly removed.
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@docs/AUTH.md`:
- Around line 297-301: Update the Prisma documentation sentence in AUTH.md to
state that prisma/schema.prisma declares the PostgreSQL datasource provider,
while runtime adapter wiring is configured separately in src/lib/prisma.ts.
Avoid implying that the schema itself configures `@prisma/adapter-neon`.
- Around line 64-76: The Prisma setup dependencies are incomplete and
inconsistent across the documentation. In docs/AUTH.md, update the initial
install command to include `@prisma/adapter-neon` and `@neondatabase/serverless`
alongside prisma and `@prisma/client`; in docs/TECH-SPECS.md, update the
dependency table and runtime dependency count to include both Neon packages.
- Around line 332-334: Update docs/AUTH.md lines 332-334 to identify “migrate
dev” as local-development troubleshooting only and direct production users to
“migrate deploy”; update docs/TECH-SPECS.md lines 102-107 to label both “migrate
dev” and “db push” as development-only, then add “migrate deploy” for production
deployments.
In `@README.md`:
- Around line 241-243: Update the documentation tree in README.md to include
docs/DEPLOYMENT.md and docs/AUDIT-FOLLOWUPS.md alongside the existing entries,
keeping it consistent with the documentation index links.
🪄 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: CHILL
Plan: Pro Plus
Run ID: 0635ed75-6a94-4bb5-82ef-8cab62249b40
📒 Files selected for processing (7)
AGENTS.mdCLAUDE.mdREADME.mddocs/ARCHITECTURE.mddocs/AUTH.mddocs/FEATURES.mddocs/TECH-SPECS.md
…eploy - docs/AUTH.md: clarified that prisma/schema.prisma only declares the postgresql provider — the DATABASE_URL/adapter-neon runtime wiring lives in prisma.config.ts / src/lib/prisma.ts, not the schema. - docs/AUTH.md + docs/TECH-SPECS.md: added the two Neon packages (@prisma/adapter-neon, @neondatabase/serverless) to the install command and dependency table; also refreshed the dependency table's stale versions (^5.0.0 Prisma, ^11.0.0 motion, etc. — actual package.json has 7.8.0/12.42.2) and added the Astryx/phosphor-icons/ dotenv packages that were missing from it entirely. Dropped the "total runtime dependency count" line in favor of pointing at package.json, since a hardcoded count is exactly the kind of number that goes stale silently. - docs/AUTH.md + docs/TECH-SPECS.md: distinguished `migrate dev` (local development) from `migrate deploy` (production/CI — doesn't prompt interactively). - README.md: added docs/DEPLOYMENT.md and docs/AUDIT-FOLLOWUPS.md to the project structure tree, matching the Documentation section's links.
|
ECC bundle files are already tracked in this repository. Skipping generation of another bundle PR. |
Summary
The database has been Postgres (via
@prisma/adapter-neon) since the B-04 audit fix, butREADME.md,AGENTS.md, and severaldocs/files still described SQLite as current — including a literalprovider = "sqlite"schema snippet andfile:./dev.dbenv examples that would produce a broken setup if followed today. Fixed all current-state references. Leftdocs/AUDIT-FOLLOWUPS.md's historical finding anddocs/HANDOFF.md's dated 2026-07-20 snapshot alone, since both are accurate records of a specific point in time, not claims about the app today.Also fixed env var names to match
.env.example/src/lib/auth.ts(AUTH_SECRET, notNEXTAUTH_SECRET/NEXTAUTH_URL— this repo runs NextAuth v5's Auth.js env var convention and doesn't need a URL var at all).Other fixes:
core/as a flat 3-file module andCreateCampaignWizard.tsxas a top-level file; updated to match the realcore/engine/+core/slices/split and thewizard/subdirectory with per-ad-type steps.targetingMode(which is actually'Keyword'); corrected.CLAUDE.md.docs/TECH-SPECS.md's file-statistics table was stale in both directory shape and line counts (e.g. citing a single 600-lineengine.tsthat hasn't existed since the engine/ split); refreshed with real counts and dated the snapshot so future staleness is at least self-documenting.CHANGELOG.mdand existing-but-unlinkeddocs/DEPLOYMENT.mdfrom README's Documentation section.CLAUDE.md: documented the new.claude//.agents//.codex/ECC bundle (feat: add Amazon-ad-console ECC bundle #56) and flagged that its auto-generated skill file contains at least one inaccurate claim (invented camelCase filename examples that don't match this repo's real PascalCase-components / lowercase-engine-modules convention) —CLAUDE.mdremains the authoritative source when they disagree.Test plan
npx tsc --noEmitnpx vitest run(668 tests passing — docs-only change, included as a sanity check)prisma/schema.prisma,.env.example,src/lib/auth.ts,src/lib/prisma.ts,store.ts,wc -lon the real file tree) rather than guessingGenerated by Claude Code
Summary by CodeRabbit