Skip to content

docs: sync all documentation with the current implementation#8

Merged
scumunna merged 3 commits into
mainfrom
docs/sync-with-implementation
Jun 23, 2026
Merged

docs: sync all documentation with the current implementation#8
scumunna merged 3 commits into
mainfrom
docs/sync-with-implementation

Conversation

@scumunna

Copy link
Copy Markdown
Owner

A full documentation pass: review the codebase and correct every stale fact so the docs match what actually ships on main.

What was stale → corrected (all verified against source)

Claim Was Now Source of truth
Lessons 124 225 (115 role + 110 vertical) Curriculum.swift, ls Content/Lessons
Certification exams "9 role" 20 (9 role + 11 vertical) ls Content/Exams
Native test checks "2,500+" 5,127 ./Scripts/test.sh
Web explorables 3 13 (incl. Pixel Setup) web/src/App.tsx NAV
Web tests (unstated) 147 cd web && npm test
Version (Status) "BidLab 1.0" v1.1.1 (latest release) + link to docs/ACCEPTANCE.md GitHub releases

Files

  • README.md — every count above; expanded the web-demo description to all 13 explorables; added a web build/test quickstart; linked the acceptance-evidence report.
  • Content/CONTENT_GUIDE.mdtrack list now includes adops, ai, and all 11 vertical-* tracks (was missing); widget catalog adds pixelSetup/pixelCalculators; replaced the stale "only 3 widgets are interactive" note (all catalog types now render live except monteCarlo) and documented the WidgetRegistry + knownWidgets whitelist gotcha.
  • web/src/App.tsx — corrected the public demo footer ("124 ... certification exams" → "225 ... 20 certification exams").

Verification

  • cd web && npm run build → typecheck + vite build clean
  • cd web && npm test147 passed
  • ./Scripts/test.sh5,127 native checks passed (Swift untouched in this PR)
  • Grep confirms no 124 / 2,500 stale stats remain; all referenced screenshots and og.png exist.

Deliberately not touched

  • reviews/*.md are point-in-time review-cycle snapshots (e.g. "Cycle 1 baseline"), not living docs — rewriting them would falsify history.
  • The in-app About string (SettingsSurface.swift:130) still reads "BidLab 1.0". Picking the next version number is a release decision, so it is flagged for you rather than guessed here.

🤖 Generated with Claude Code

Stephen Umunna and others added 2 commits June 21, 2026 22:00
The README and CONTENT_GUIDE had drifted from the shipped product. Correct
every stale count and capability claim against the source of truth:

- 225 lessons (was 124): 115 across 9 role paths + 110 across 11 verticals,
  counted from Curriculum.swift and Content/Lessons/.
- 20 certification exams (was "9 role"): 9 role + 11 vertical.
- 5,127 native known-answer checks (was "2,500+"), from ./Scripts/test.sh.
- Web demo is 13 interactive explorables incl. Pixel Setup (was listed as 3),
  147 web tests; added a web build/test quickstart.
- Latest release is v1.1.1 (Status said "BidLab 1.0"); link docs/ACCEPTANCE.md.
- CONTENT_GUIDE: track list now includes adops, ai, and all 11 verticals; the
  widget catalog adds the pixel widgets; the stale "only 3 are interactive"
  note is replaced (all catalog types render live except monteCarlo) with the
  WidgetRegistry + knownWidgets-whitelist gotcha.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The public web demo footer claimed "124 interactive lessons ... certification
exams". Update to 225 lessons and 20 certification exams to match the app.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…0 web)

#9 raised the native suite to 5,271 checks and #10 the web suite to 180; update
the README and ACCEPTANCE.md to match, and add the CI coverage-gate story (web
100%, native 100% of reachable code). ACCEPTANCE.md's web engine-suite row now
includes the added boundary tests (47 -> 80).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@scumunna scumunna merged commit 2a6cd3c into main Jun 23, 2026
2 checks passed
@scumunna scumunna deleted the docs/sync-with-implementation branch June 23, 2026 18:10
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