Pre-commit doc-layout violations block new commits #21

Closed
opened 2026-05-28 00:03:10 +00:00 by coilysiren · 0 comments
Owner

Problem

Pre-existing documentation-layout and Markdown size cap violations in the backend repo block any new commit via the canonical pre-commit suite:

  • todos/{anthropic,aws,discord,github,reddit,sentry,steam,youtube}.md live in todos/, but the rule allows Markdown only at repo root, docs/*.md, or inside a skill folder.
  • README.md is 88 lines, over the 80-line cap.

These all predate the rip-out work in #20. The rip-out itself is a clean YAML edit but cannot land until the doc tree clears the hook, because --no-verify is forbidden.

Proposal

  • Move every todos/*.md to docs/todo-<name>.md (filename prefix groups them; flat docs/ is required).
  • Split README.md into the under-80 root + a docs/<topic>.md follow-up for the overflow.
  • Land the cleanup as a standalone PR/commit; #20 can then land on top.
**Problem** Pre-existing `documentation-layout` and `Markdown size cap` violations in the backend repo block any new commit via the canonical pre-commit suite: - `todos/{anthropic,aws,discord,github,reddit,sentry,steam,youtube}.md` live in `todos/`, but the rule allows Markdown only at repo root, `docs/*.md`, or inside a skill folder. - `README.md` is 88 lines, over the 80-line cap. These all predate the rip-out work in #20. The rip-out itself is a clean YAML edit but cannot land until the doc tree clears the hook, because `--no-verify` is forbidden. **Proposal** - Move every `todos/*.md` to `docs/todo-<name>.md` (filename prefix groups them; flat `docs/` is required). - Split `README.md` into the under-80 root + a `docs/<topic>.md` follow-up for the overflow. - Land the cleanup as a standalone PR/commit; #20 can then land on top.
Sign in to join this conversation.
No labels
P0
P1
P2
P3
P4
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
coilyco-flight-deck/backend#21
No description provided.