Skip to content

docs: sync README/DESIGN.md against actual repo state - #16

Closed
serpeigd wants to merge 1 commit into
mainfrom
claude/modest-brahmagupta-vap5qj
Closed

docs: sync README/DESIGN.md against actual repo state#16
serpeigd wants to merge 1 commit into
mainfrom
claude/modest-brahmagupta-vap5qj

Conversation

@serpeigd

@serpeigd serpeigd commented Aug 23, 2026

Copy link
Copy Markdown
Owner

Docs-only sync. Verified against the working tree, not the changelog.

  • Researched catalogue: README said 8/20, actual is 23 (18/20 measurement titles + 5 more). Updated every count/list that still referenced 8.
  • Disclosed the "+ Suggest a movie" auto-publish path (writes straight to content/researched/, no review step — a deliberate, documented risk per webapp/app.py's own module docstring). README previously implied every path into content/researched/ went through human review, which stopped being true on 2026-08-19.
  • CI has been failing on every push since 2026-08-19 — test_auto_publish.py/test_groq_retry.py import fastapi/groq/httpx without pytest.importorskip, and tests.yml never installs those, so collection is interrupted before any test runs. README was claiming "18/26 passing in CI." Not fixed here (product/CI-config change, out of scope for a docs-only pass) — just documented.
  • Corrected the test count (26 → 35, verified by actually running the suite locally: 31 pass, 4 more need sentence-transformers).
  • Noted Groq's 2026-08-18 model decommission next to the LLMJudge comparison numbers that cite the now-gone model names (numbers are historically accurate, just no longer what running the command today would use).
  • docs/DESIGN.md: added D17 for the auto-publish decision, closed the "Pending" bullet that still said this wasn't built.

No product or measurement-track code touched.

Note: this body was edited to remove a leaked session-tracking URL from the original attribution footer — content otherwise unchanged. See #17, which supersedes this PR.

- Researched catalogue: 8/20 -> 23 entries (18/20 measurement titles +
  5 more); update every count/list that referenced the old 8.
- Disclose the "+ Suggest a movie" auto-publish path (no review step,
  a deliberate risk per app.py's own docstring) -- README implied every
  path into content/researched/ still went through human review.
- CI is currently failing on every push since 2026-08-19 (test_auto_publish.py/
  test_groq_retry.py import fastapi/groq/httpx without importorskip,
  tests.yml never installs them) -- was claiming 18/26 passing.
- Correct test count (26 -> 35, verified by running the suite locally).
- Note Groq's 2026-08-18 model decommission next to the LLMJudge
  comparison numbers that used the now-gone model names.
- docs/DESIGN.md: add D17 for the auto-publish decision, close the
  stale Pending bullet claiming it wasn't built yet.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Copy link
Copy Markdown
Owner Author

Closing in favor of #17, which folds in this PR's findings (all verified accurate against the current tip of main) plus the same CI-failure disclosure. Content is equivalent; #17 is the up-to-date one going forward.

Also edited this PR's body above to strip a leaked session-tracking URL from the original attribution footer (content otherwise unchanged) — flagging per this org's "never push session/environment identifiers" rule.


Generated by Claude Code

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