Skip to content

docs: Correct False and Stale Factual Claims - #176

Merged
droid-ash merged 4 commits into
mainfrom
260731-xkfl-correct-false-stale-claims
Jul 31, 2026
Merged

docs: Correct False and Stale Factual Claims#176
droid-ash merged 4 commits into
mainfrom
260731-xkfl-correct-false-stale-claims

Conversation

@droid-ash

@droid-ash droid-ash commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Meta

Change ID Type Confidence Plan Review
xkfl docs 5.0/5.0 11/11 tasks, 14/14 acceptance ✓ ✓ 2 cycles
Impact +/− Net
true +609 / −51 +558
└ impl +605 / −47 +558
└ tests +4 / −4 +0

generated 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

  • Removed the fabricated 67/18 comment-density ratio from fab/project/code-quality.md; the deletion test alone now carries the compliance argument
  • Past-tensed the fab/project/code-review.md sweep-scope bullet to reference the merged PR docs: Comment Content Sweep #171 sweep so it is not re-run
  • Fixed packages/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 rationale
  • Repointed the twice-rotted logger.ts:103-105 citations in logWriteStream.ts and docs/memory/device-node/log-capture.md to a line-number-free anchor
  • Replaced five false "used-by" headers naming Dart-predecessor symbols that never existed in this repo (constants.ts ×2, Hierarchy.ts, DriverServiceImpl.kt, GrpcDriverServer.kt) with grep-verified real consumers
  • Corrected docs/memory/drivers/grpc-contract.md's fps-default attribution: gRPC StartStreaming defaults to 24 (per proto/Swift), the legacy WebSocket path defaults to 1
  • Fixed five pre-existing false claims in docs/codebase-walkthrough.md (package count, runTestCommand line range, action-type count, Package Map table paths, checkRunner path)
  • Completed change 260731-3vhw's bookkeeping .status.yaml via fab tooling, closing a stuck review-pr: active record for an already-merged PR
  • Hydrate pass additionally corrected the same stale used-by/consumer-count claims in docs/memory/common/env.md and docs/memory/common/hierarchy.md
  • Nice-to-haves: reworded the constants.ts consumer-set comment and dropped the unverifiable Hierarchy.ts file-size figure

Summary by CodeRabbit

  • Documentation

    • Corrected outdated and inaccurate claims across architecture, package structure, hierarchy handling, CLI reporting, and platform integrations.
    • Clarified gRPC streaming behavior: Android and Swift default to 24 FPS when unspecified, while legacy WebSocket behavior remains 1 FPS.
    • Added guidance on backward-compatible environment exports and documented current consumers and implementation boundaries.
    • Replaced fragile line-number references with durable source references.
  • Chores

    • Updated workflow records and review status metadata to reflect completed documentation maintenance.

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.
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b2c66c1b-9e3d-4f68-9989-64424995611b

📥 Commits

Reviewing files that changed from the base of the PR and between 94412a5 and 456a978.

📒 Files selected for processing (3)
  • docs/memory/drivers/grpc-contract.md
  • fab/changes/260731-xkfl-correct-false-stale-claims/.history.jsonl
  • fab/changes/260731-xkfl-correct-false-stale-claims/.status.yaml

📝 Walkthrough

Walkthrough

The 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.

Changes

Documentation and bookkeeping corrections

Layer / File(s) Summary
Correction scope and verification plan
fab/changes/260731-xkfl-correct-false-stale-claims/intake.md, fab/changes/260731-xkfl-correct-false-stale-claims/plan.md, fab/project/code-quality.md, fab/project/code-review.md
The change plan and policy files define and record documentation-only corrections for stale metrics, citations, consumer claims, paths, package details, streaming defaults, and workflow status.
Repository facts and source comments
docs/codebase-walkthrough.md, docs/memory/..., drivers/android/.../grpc/*.kt, packages/common/src/..., packages/device-node/src/device/logWriteStream.ts
Documentation and comments now describe the seven-package layout, React/Vite report frontend, verified hierarchy consumers, corrected paths, gRPC/WebSocket defaults, compatibility exports, and current TypeScript consumers.
Fab workflow records
fab/changes/260731-3vhw-delete-dead-code-audit-targets/*, fab/changes/260731-xkfl-correct-false-stale-claims/.history.jsonl, fab/changes/260731-xkfl-correct-false-stale-claims/.status.yaml
History and status metadata now record review completion, workflow transitions, stage timestamps, pull-request tracking, impact data, and shipment state.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: arnoldlaishram

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately summarizes the primary change: correcting false and stale factual claims across documentation, comments, and project files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 260731-xkfl-correct-false-stale-claims

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 91b2683 and 94412a5.

📒 Files selected for processing (20)
  • docs/codebase-walkthrough.md
  • docs/memory/common/env.md
  • docs/memory/common/hierarchy.md
  • docs/memory/common/index.md
  • docs/memory/device-node/log-capture.md
  • docs/memory/drivers/grpc-contract.md
  • drivers/android/app/src/androidTest/java/app/finalrun/android/grpc/DriverServiceImpl.kt
  • drivers/android/app/src/androidTest/java/app/finalrun/android/grpc/GrpcDriverServer.kt
  • fab/changes/260731-3vhw-delete-dead-code-audit-targets/.history.jsonl
  • fab/changes/260731-3vhw-delete-dead-code-audit-targets/.status.yaml
  • fab/changes/260731-xkfl-correct-false-stale-claims/.history.jsonl
  • fab/changes/260731-xkfl-correct-false-stale-claims/.status.yaml
  • fab/changes/260731-xkfl-correct-false-stale-claims/intake.md
  • fab/changes/260731-xkfl-correct-false-stale-claims/plan.md
  • fab/project/code-quality.md
  • fab/project/code-review.md
  • packages/common/src/constants.ts
  • packages/common/src/env.ts
  • packages/common/src/models/Hierarchy.ts
  • packages/device-node/src/device/logWriteStream.ts

Comment thread docs/codebase-walkthrough.md
Comment thread docs/memory/drivers/grpc-contract.md Outdated
Comment thread fab/changes/260731-xkfl-correct-false-stale-claims/plan.md
droid-ash and others added 2 commits July 31, 2026 13:22
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>
@droid-ash
droid-ash marked this pull request as ready for review July 31, 2026 17:16
@droid-ash
droid-ash merged commit bc6e634 into main Jul 31, 2026
3 of 4 checks passed
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