docs: Correct False and Stale Factual Claims - #176
Conversation
Truth pass fixing fabricated ratios, rotted line-number citations, and false used-by attributions across comments and memory docs. No runtime changes — only comment/doc lines touched in .ts/.kt files.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe PR corrects stale or false claims across repository documentation, source comments, policy files, and Fab workflow records. It updates package structure, consumer ownership, file paths, streaming defaults, compatibility rationale, and review-status metadata without changing runtime behavior. ChangesDocumentation and bookkeeping corrections
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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 `@docs/codebase-walkthrough.md`:
- Around line 682-685: Rename the second table column header from "React SPA
(`report-web`)" to "Report frontend" to accurately reflect that report-web is a
frontend asset, not a server implementation. Update the Technology row
description to clarify that the Vite + React SPA bundle is embedded in the CLI
and runtime tarball as a primary use case, with standalone development and
custom deployment as additional modes. Additionally, update the package-map
entries at lines 1173-1175 that incorrectly describe Next.js App Router routes
for the report-web package, since report-web uses Vite and React, not Next.js.
In `@docs/memory/drivers/grpc-contract.md`:
- Line 128: Update the clamp rationale in the fps documentation to accurately
state that it prevents invalid divisor values below 1 and bounds hierarchy
snapshot load above 60; remove the unsupported “unbounded” and
snapshot-performance claim unless you add concrete supporting measurements.
In `@fab/changes/260731-xkfl-correct-false-stale-claims/plan.md`:
- Around line 111-113: Update the package-count references in the walkthrough so
every occurrence, including the “Why 5 packages?” heading, reflects 7 packages;
alternatively remove the numeric heading while retaining the two new package
rows and architecture updates.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: f23c84bc-38d1-4553-970f-b0e15888b8cb
📒 Files selected for processing (20)
docs/codebase-walkthrough.mddocs/memory/common/env.mddocs/memory/common/hierarchy.mddocs/memory/common/index.mddocs/memory/device-node/log-capture.mddocs/memory/drivers/grpc-contract.mddrivers/android/app/src/androidTest/java/app/finalrun/android/grpc/DriverServiceImpl.ktdrivers/android/app/src/androidTest/java/app/finalrun/android/grpc/GrpcDriverServer.ktfab/changes/260731-3vhw-delete-dead-code-audit-targets/.history.jsonlfab/changes/260731-3vhw-delete-dead-code-audit-targets/.status.yamlfab/changes/260731-xkfl-correct-false-stale-claims/.history.jsonlfab/changes/260731-xkfl-correct-false-stale-claims/.status.yamlfab/changes/260731-xkfl-correct-false-stale-claims/intake.mdfab/changes/260731-xkfl-correct-false-stale-claims/plan.mdfab/project/code-quality.mdfab/project/code-review.mdpackages/common/src/constants.tspackages/common/src/env.tspackages/common/src/models/Hierarchy.tspackages/device-node/src/device/logWriteStream.ts
Correct the fps-clamp rationale in grpc-contract.md: below 1 the failure is an invalid divisor (integer division-by-zero / negative-to-UInt64 traps in GrpcDriverServer.swift, unbounded or negative intervals on the floating-point paths), and the 60 upper bound is a chosen load cap, not a measured ceiling. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Meta
xkflgenerated by fab-kit v2.16.8
Pipeline: intake ✓ → apply ✓ → review ✓ → hydrate ✓ → ship → review-pr
Summary
Eight clusters of factual claims across fab policy, source comments, docs, and memory were false when written or rotted after later PRs moved the ground under them — from a fabricated comment-density ratio to line-number citations that decayed twice, several introduced by this very pipeline. Left standing, these files feed every future apply/review pass and are declared authoritative for memory, so the wrong claims would propagate. This change is a single docs/comments-only truth pass: every correction was re-verified against the current tree (measured counts, grepped symbols, read the cited code) with zero runtime behavior changes.
Changes
fab/project/code-quality.md; the deletion test alone now carries the compliance argumentfab/project/code-review.mdsweep-scope bullet to reference the merged PR docs: Comment Content Sweep #171 sweep so it is not re-runpackages/common/src/env.ts's re-export shim comment, which cited the constitution's Test Integrity rule backwards; it now states the verified consumer-compatibility rationalelogger.ts:103-105citations inlogWriteStream.tsanddocs/memory/device-node/log-capture.mdto a line-number-free anchorconstants.ts×2,Hierarchy.ts,DriverServiceImpl.kt,GrpcDriverServer.kt) with grep-verified real consumersdocs/memory/drivers/grpc-contract.md's fps-default attribution: gRPCStartStreamingdefaults to 24 (per proto/Swift), the legacy WebSocket path defaults to 1docs/codebase-walkthrough.md(package count,runTestCommandline range, action-type count, Package Map table paths,checkRunnerpath)260731-3vhw's bookkeeping.status.yamlvia fab tooling, closing a stuckreview-pr: activerecord for an already-merged PRdocs/memory/common/env.mdanddocs/memory/common/hierarchy.mdconstants.tsconsumer-set comment and dropped the unverifiableHierarchy.tsfile-size figureSummary by CodeRabbit
Documentation
Chores