Skip to content

Doc & to-do TLC proposal -- 2026-07-27 #3

Description

@isensystech

Automated documentation-hygiene sweep. Propose-only — no files were changed, moved, or deleted. This issue is the entire output of the run.

Inventory method

  • Searched for *.md, plus filenames matching *ToDo*, *TODO*, *RnD*, *RND*, and any *research* directories (e.g. ride-research/, l2-research/).
  • Excluded .git/, node_modules/, and CLAUDE.md per instructions.
  • Result: only two candidate files exist in the repo. No dedicated TODO/RnD files and no research directories were found.
  • Cross-checked each file's claims against git log --oneline -40 and the current tree (app.py, scripts/, static/js/, etc.) before classifying.

Findings

File Recommendation Rationale (evidence)
README.md UPDATE (minor) Actively maintained — recent commits 508e0e9 ("Add to-do item in README"), 552ef2b/ce837f8 ("Mark completed tasks in README.md") show it's a living doc. Roadmap items check out against code: [x] Create attitude gauge and [x] Create ZEN mode are corroborated by commits ef0f094, a2ec0fa, 4c554f3, b763f0f. Not stale, but the "Roadmap" and "To-Do Frontend MVP" checklists contain duplicate entries — "Collective Power Trim Tab Joystick binding", "Create Moving maps background", and "Create Video feed screen" are each listed twice, and "Create Tacktical Map View" is listed three times (README.md lines 161-177). Recommend a human dedupe pass; content itself is current, so no archival needed.
KiloWebInterface_Deployment_Instructions.md KEEP Verified every referenced path/command against the current tree: app.py, requirements.txt, scripts/preview.sh, scripts/preview.ps1 all exist and match what the doc describes (git clone → venv → pip install fastapi uvicornpython app.py → nginx reverse proxy → systemd unit). No superseding deployment doc found elsewhere in the repo. Operational/boat-specific content (IPs, credentials, systemd unit) is not something code changes would make stale, and nothing in it contradicts current app.py behavior.

No *ToDo*/*TODO*/*RnD*/*RND* files and no *research* directories exist in the repository, so there is nothing further to assess in those categories.

Summary

  • 2 files assessed (excluding CLAUDE.md, which was skipped per instructions)
  • KEEP: 1 · UPDATE: 1 (minor, duplicate checklist lines only) · ARCHIVE: 0 · DELETE-CANDIDATE: 0

2 files flagged, 1 with a (minor) recommendation. No files were changed — this run is propose-only.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions