Skip to content

docs: correct stale test count, pnpm pin, and repo layout in the public docs - #45

Merged
AlaskanTuna merged 1 commit into
mainfrom
docs/fix-readme-runbook-accuracy
Aug 25, 2026
Merged

docs: correct stale test count, pnpm pin, and repo layout in the public docs#45
AlaskanTuna merged 1 commit into
mainfrom
docs/fix-readme-runbook-accuracy

Conversation

@AlaskanTuna

Copy link
Copy Markdown
Owner

Fixes seven factual inaccuracies in README.md and RUNBOOK.md found by a documentation-accuracy audit that checked every claim against the code.

# Claim Reality
1 README tech table: "205 passing" pnpm test407 (216 frontend + 191 backend)
2 pnpm 10.33.0 (README badge, quickstart, prerequisites; RUNBOOK §1 ×2) package.json pins 10.33.3 — the RUNBOOK validation checkpoint (pnpm -v reports 10.33.0) failed on a fresh clone
3 Repo layout lists tests/smoke/ No smoke/ dir exists, and tests/ is gitignored — it was never part of the published tree
4 schema.prisma "(Location, Project, TariffConfig, Quota)" No Quota model; the auth models (User/Session/Account) were missing
5 Routes comment omits /chat backend/src/routes/chat.ts and the whole services/chat/ subtree exist
6 RUNBOOK §13.1 does not explain why runtime: node is in render.yaml Load-bearing since #18: Render auto-detects the root Dockerfile otherwise. The trap was documented only in a render.yaml comment, not in the runbook
7 Last verified: 03/05/26 (against main @ <replace-with-current-sha>) The placeholder was never filled in, and the date predates 20 merges

The layout tree also now surfaces Dockerfile and docker-compose.yml, which shipped in #18 and were invisible in the tree.

Verified alongside: all 15 RUNBOOK TOC anchors resolve, every pnpm command in both docs exists in package.json, RUNBOOK §4 + Appendix A match the Zod schema in backend/src/config/env.ts exactly (no extra, no missing), all repo-relative asset links resolve, and both external links (milestone 1, the v1.1-walkthrough release asset) are live.

https://claude.ai/code/session_01URDpaxhXyPLWnUQtvowNyM

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f6e231ff-aee6-44ef-a07d-04378c8f9ac7


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.

@AlaskanTuna
AlaskanTuna merged commit c5e5b31 into main Aug 25, 2026
3 checks passed
@AlaskanTuna
AlaskanTuna deleted the docs/fix-readme-runbook-accuracy branch August 25, 2026 11:30
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.

1 participant