chore: WS-2/WS-7 verification + comprehensive README + critical-docs audit - #296
Merged
Conversation
Manual doc-truth pass (WS-7) -- these claims don't match any of the doc-metrics gate's automated patterns (no version string, no tag/release marker), so drift here can only be caught by checking each claim against the real implementation: - RTCDataChannel E2E encryption (duplicated 3x across old dated sections): already shipped in packages/collab-transport (vendor fork y-webrtc 10.3.0, C-1) -- confirmed via that package's own AUDIT.md. - RTL language support (duplicated 3x): Beta-shipped (ar/he/fa behind enableRtlLayout), redundant with the more detailed/current "C-6" entry. - LoRA fine-tuning support (duplicated 3x): shipped, default-on enableLoraAdapters flag. - Whisper WASM STT: engine + download UI shipped; only E2E test coverage remains open. - Kokoro/Piper TTS: Kokoro shipped and tested; Piper is still just an unimplemented type-level placeholder, not a real engine.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughUpdated project tracking, review workflow instructions, release metadata, security policy, technology-stack guidance, and README feature and testing documentation. ChangesDocumentation reconciliation
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🏁 CodeAnt Quality Gate ResultsCommit: ✅ Overall Status: PASSEDQuality Gate Details
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…eatures Full pass over README.md against actual current repo state: Factual corrections: - Test metrics were stale (2026-07-28 snapshot): badge + 4 in-body mentions said "5807+ tests / 531 files" -- verified via the actual Vitest JSON artifact from a completed CI run (numTotalTests/testResults.length), now correctly "6477 tests / 529 files" (2026-07-30). - Tech-stack table said "TypeScript 6 (strict)" while the version badge and every other TS mention in the file already said "TypeScript 7 (tsgo)" -- package.json confirms tsgo (@typescript/native-preview); fixed the contradiction. - Removed a broken ToC link to "Deutsche Version (German)" -- no such section exists anywhere in the file, so the anchor 404s. - CI job table was missing two real, currently-running jobs: `e2e-deep` (E2E Deep Coverage feature-flag matrix, continue-on-error) and `vrt` (Visual Regression) -- both confirmed present in ci.yml. - Project Structure diagram didn't list `packages/worker-bus`, the central WorkerBus v2 orchestration package (ADR-0015) that DuckDB, local embeddings, and local NLP all now route through. Coverage additions -- 13 shipped, mostly default-on features had zero README mention despite full documentation in CLAUDE.md/featureCatalog.ts: - New "Story Organization & Research" section: Story Objects & Groups, Enhanced Mind Maps, Character Interviews v2, Research Binder, Compile Wizard. - New "Performance, Analytics & Extensibility" section: DuckDB Analytics, WorkerBus v2, Adaptive AI Engine, Compute Shaders, Rust Compute (desktop), Plugin System v0.1, LoRA Adapter Inference, App Health Panel. Every number and file/package reference here was verified against the current codebase, not carried over from the previous README text.
… state Same evidence-based doc-truth pass as the README audit, extended to the most critical remaining user-facing and agent-instruction docs: - AUDIT.md: "Current version" was still v1.24.2 -- two releases (#293, #294 doc-truth/codify work) had already landed on main since. Updated the header chain and current-version summary to v1.24.3. - ROADMAP.md: no v1.24.3 entry existed at all, even though it explicitly said worker-generation-duplication consolidation was "deferred to a dedicated migration sprint" -- that sprint shipped as v1.24.3. Added the release section and removed a stale "Upcoming" bullet asking to "finalise & test RTCDataChannel E2E encryption" -- already shipped (same finding as the TODO.md fix in this PR). - .github/SECURITY.md: supported-versions table said `main (v1.19.0)`, five releases behind actual v1.24.3. - docs/SECURITY-THREAT-MODEL.md: header said "v1.22.0 baseline" while the body already documented the v1.24.2 desktop-crypto fix (F-05/F-06) -- inconsistent self-reference, not a substance error. - AGENTS.md: tech-stack table had six stale pinned versions (TypeScript claimed a nonexistent "~6.0.3" -- the project has no plain `typescript` package, only `@typescript/native-preview` beta/tsgo; Tailwind, Biome, Storybook, Zustand, Vitest, Playwright were all behind actual package.json versions). - CLAUDE.md, .github/copilot-instructions.md, .cursorrules, KIMI-INSTRUCT.md, docs/CODEANT-REVIEW-LOOP.md: all five wrote the PR review-comment policy CodeAnt-centric (re-trigger `@codeant-ai review`), but empirically across every PR in this session's sprint, CodeRabbit was the bot actually posting inline comments (`@coderabbitai review`); CodeAnt only ever appeared as 5 CI status checks. Added a clarifying note to each so a future session doesn't re-trigger the wrong bot and miss real findings -- this already happened once this session. Deliberately NOT touched: docs/history/** session-handoff/sprint archives (point-in-time records, not living docs -- only a factual error about what happened would warrant a fix there, not staleness relative to today); docs/i18n/TRANSLATION_STATUS.md (auto-generated by `pnpm run i18n:status`, but regenerating it silently deletes a manually-maintained "Review & Elevation Log" section the generator script doesn't know about -- a real script gap, left as-is rather than risk destroying that audit trail); AUDIT.md's historical "Markdown corpus" file-count entries (all inside dated audit-log sections, correctly excluded by the doc-metrics gate already).
qnbs
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 @.cursorrules:
- Line 49: Use CodeRabbit as the single authoritative inline-review trigger
across all workflow documentation: update .cursorrules lines 49-49 to replace
the CodeAnt command while retaining CodeAnt only for status verification; update
.github/copilot-instructions.md lines 129-132 and its preceding workflow trigger
at line 125 to CodeRabbit; remove the conflicting CodeAnt retrigger from
CLAUDE.md lines 54-54; update KIMI-INSTRUCT.md lines 43-49, sections 3.6–3.7, to
use CodeRabbit terminology and triggering; and update
docs/CODEANT-REVIEW-LOOP.md lines 11-18 with the CodeRabbit downstream trigger
and corresponding “fresh review” wording.
In @.github/SECURITY.md:
- Around line 7-8: Update the support-version table in SECURITY.md to explicitly
classify releases 1.24.0–1.24.2, either by adding a 1.24.x row with the
appropriate support status or by clarifying why support begins only at v1.24.3,
while preserving the existing main and 1.3.x–1.23.x entries.
In `@AGENTS.md`:
- Around line 47-59: Synchronize the project version metadata in AGENTS.md with
the established v1.24.3 release referenced by ROADMAP.md and AUDIT.md. Update
the version currently shown as 1.23.0, or explicitly label it as historical if
it must remain unchanged.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5776b95a-c4ae-4eee-87f6-57d034b33fcc
📒 Files selected for processing (11)
.cursorrules.github/SECURITY.md.github/copilot-instructions.mdAGENTS.mdAUDIT.mdCLAUDE.mdKIMI-INSTRUCT.mdREADME.mdROADMAP.mddocs/CODEANT-REVIEW-LOOP.mddocs/SECURITY-THREAT-MODEL.md
…n gaps Addresses 3 CodeRabbit findings on PR #296: 1. The prior commit added a clarifying note that CodeRabbit is the bot actually posting inline comments, but left the primary re-trigger instruction as the stale `@codeant-ai review` in 5 files -- a future session following the primary instruction literally would re-trigger the wrong bot and see no new comments, wrongly concluding the loop is quiescent. Made `@coderabbitai review` the authoritative re-trigger in CLAUDE.md, .github/copilot-instructions.md, .cursorrules, KIMI-INSTRUCT.md (sections 3.6-3.7), and docs/CODEANT-REVIEW-LOOP.md (both the diagram and the actual procedure body, not just its header note) -- CodeAnt AI is now described consistently as CI-status-only. 2. .github/SECURITY.md's supported-versions table had a gap: main is v1.24.3, best-effort ended at 1.23.x, leaving 1.24.0-1.24.2 unclassified. Extended the best-effort range to 1.3.x-1.24.2. 3. AGENTS.md's Project Overview still stated Version: 1.23.0, missed by the previous commit's tech-stack-table-only fix. Updated to 1.24.3.
Owner
Author
|
@coderabbitai review |
✅ Action performedReview finished.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Consolidated PR A of the post-recovery audit's remaining workstreams (WS-2 + WS-7), per the
governing
PROMPT-WSS-v1.24.xprompt, plus two doc-truth audits requested mid-review: a fullREADME.md pass, then extended to the most critical remaining agent-instruction / security /
roadmap docs.
WS-2 — reconcile feature-flag counts (target: 22 total / 16 default-on / 6 default-off):
Already fully reconciled, no commit needed —
featureFlagsSlice.tsandfeatureCatalog.tsmatch exactly, and every live doc already states 22/16/6 correctly (likely fixed incidentally by
PR #291 during the WS-RECOVER merge-queue drain).
WS-7 — triage 5 stale
TODO.mdbullets: manually verified 5 claims (RTCDataChannel E2Eencryption, RTL language support, LoRA fine-tuning, Whisper WASM STT, Kokoro/Piper TTS) against
actual shipped code — none catchable by the doc-metrics gate's automated regexes.
README.md comprehensive audit:
current numbers via the actual Vitest JSON artifact from a completed CI run: 6477 tests / 529
files.
"TypeScript 7 (tsgo)".
e2e-deep,vrt) andpackages/worker-bustothe Project Structure diagram.
README mention: Story Objects & Groups, Enhanced Mind Maps, Character Interviews v2, Research
Binder, Compile Wizard, DuckDB Analytics, WorkerBus v2, Adaptive AI Engine, Compute Shaders, Rust
Compute, Plugin System v0.1, LoRA Adapter Inference, App Health Panel.
Critical-docs audit (agent instructions, security, roadmap):
AUDIT.md: "Current version" was still v1.24.2 — updated to v1.24.3.ROADMAP.md: no v1.24.3 entry existed; added it, and removed a stale "Upcoming" bullet asking tofinalize RTCDataChannel E2E encryption (already shipped — same finding as the TODO.md fix).
.github/SECURITY.md: supported-versions table saidmain (v1.19.0), five releases stale.docs/SECURITY-THREAT-MODEL.md: header said "v1.22.0 baseline" while the body already documentedthe v1.24.2 desktop-crypto fix — inconsistent self-reference.
AGENTS.md: tech-stack table had 6 stale pinned versions (including a nonexistent TypeScript"~6.0.3" — the project has no plain
typescriptpackage, only tsgo).CLAUDE.md,.github/copilot-instructions.md,.cursorrules,KIMI-INSTRUCT.md,docs/CODEANT-REVIEW-LOOP.md: all wrote the PR review-comment policy CodeAnt-centric, butempirically CodeRabbit is the bot that actually posts inline comments in this repo (CodeAnt only
shows up as 5 CI status checks) — added a clarifying note to each so a future session doesn't
re-trigger the wrong bot and miss real findings.
Deliberately not touched:
docs/history/**session-handoff/sprint archives (point-in-timerecords, not living docs);
docs/i18n/TRANSLATION_STATUS.md(regenerating it silently deletes amanually-maintained "Review & Elevation Log" section the generator script doesn't reproduce — a
real script gap, left as-is rather than risk destroying that audit trail);
AUDIT.md's historical"Markdown corpus" file-count entries (inside dated audit-log sections, already correctly excluded
by the doc-metrics gate).
Test plan
pnpm run docs:check— OK (7 files match actual state)pnpm run lint— cleanpackage.json, actual code, or CI-authoritative artifactsSummary by CodeRabbit