chore: declare the small documentation band and adopt the hook suite #16

Merged
coilysiren merged 2 commits from aos/claude/aw85-bands into main 2026-08-17 14:10:21 +00:00
Owner

Part of coilysiren/inbox#374, the fleet documentation-band migration.

Declares the small band, adopts the managed pre-commit suite, compresses this repo's own prose (docs/mod-packages.md 53 to 34 lines, mods/docs/FEATURES.md 49 to 39), and declares the two trees whose shape this repo does not own.

The two files that are not ours to cut

The branch was authored when excludes still exempted a path from the size caps. agentic-os#1108 narrowed excludes to placement and flatness, so both surfaced:

  • unity/Assets/EcoModKit/Docs/README.md - the Eco SDK as upstream ships it, citing wiki.play.eco and Eco 0.9.6 release notes. Cutting it forks upstream docs.
  • mods/Mods/UserCode/MinesQuarries/README.md - the README that renders as that mod's mod.io store page. Cutting it changes what a player reads.

Kai's call was a vendored-tree exemption, which agentic-os#1115 adds: vendored path prefixes take no size cap, prefixes only and size only, so it cannot become the per-file escape hatch #1108 removed and cannot widen where Markdown may live. Both entries here carry their reason beside the declaration, which the rule asks for.

State

Clean against the checker on agentic-os#1115. Still red against the released aos-precommit-v0.24.0, which has no vendored key, so this needs #1115 merged and an aos-precommit-v* release before its own pin resolves. Same gate as the three .github branches.

Part of coilysiren/inbox#374, the fleet documentation-band migration. Declares the `small` band, adopts the managed pre-commit suite, compresses this repo's own prose (`docs/mod-packages.md` 53 to 34 lines, `mods/docs/FEATURES.md` 49 to 39), and declares the two trees whose shape this repo does not own. ## The two files that are not ours to cut The branch was authored when `excludes` still exempted a path from the size caps. agentic-os#1108 narrowed excludes to placement and flatness, so both surfaced: * `unity/Assets/EcoModKit/Docs/README.md` - the Eco SDK as upstream ships it, citing wiki.play.eco and Eco 0.9.6 release notes. **Cutting it forks upstream docs.** * `mods/Mods/UserCode/MinesQuarries/README.md` - the README that renders as that mod's mod.io store page. **Cutting it changes what a player reads.** Kai's call was a vendored-tree exemption, which agentic-os#1115 adds: `vendored` path prefixes take no size cap, prefixes only and size only, so it cannot become the per-file escape hatch #1108 removed and cannot widen where Markdown may live. Both entries here carry their reason beside the declaration, which the rule asks for. ## State Clean against the checker on agentic-os#1115. **Still red against the released `aos-precommit-v0.24.0`**, which has no `vendored` key, so this needs #1115 merged and an `aos-precommit-v*` release before its own pin resolves. Same gate as the three `.github` branches.
Applied by agentic-os scripts/apply-agentic-os-hooks.py at
aos-precommit-v0.24.0. The repo root is clean under small.

* README, AGENTS.md, and docs/FEATURES.md gained See also sections, AGENTS the
  five standard headings it lacked, CLAUDE.md bridges to it.
* Seven CI steps used YAML block scalars or inlined a 40-line Python program
  through python3 -c. All now call tracked scripts under scripts/ on one line.
* docs/mod-packages.md and mods/docs/FEATURES.md trimmed under the caps.
* .github/actionlint.yaml declares the Forgejo docker runner label.
* mods/, unity/, and unity-embedded/ excluded from layout, mirroring what
  eco-app and eco-ops already declare for the same reason.

NOT green, which is why this is a branch rather than main. Ten violations remain
and every one is in a legacy subtree from when these were standalone repos:
the vendored Strange Loop Games EcoModKit docs, one mod.io listing README, and
four forked AGENTS/CLAUDE load-point rungs. Symlinking the rungs breaks the root
file's relative links, so that needs a decision rather than a mechanical fix,
and the size failures are the agentic-os#1108 excludes revocation now open on
coilysiren/inbox#374 for seven repos.

Refs coilysiren/inbox#374

Co-authored-by: Kai Siren <coilysiren@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
docs(bands): compress mods/docs/FEATURES.md under the small band
All checks were successful
ci / Root hygiene (pull_request) Successful in 4s
ci / Repo secret scan (pull_request) Successful in 5s
ci / mods code path (pull_request) Successful in 10s
ci / publish-bunwulf-agricultural (pull_request) Has been skipped
ci / publish-bunwulf-biochemical (pull_request) Has been skipped
ci / publish-bunwulf-educational (pull_request) Has been skipped
ci / publish-bunwulf-hardware-co (pull_request) Has been skipped
ci / publish-direct-carbon-capture (pull_request) Has been skipped
ci / publish-eco-nil (pull_request) Has been skipped
ci / publish-mines-quarries (pull_request) Has been skipped
ci / publish-shop-boat (pull_request) Has been skipped
ci / publish-world-counter (pull_request) Has been skipped
0f3ace95b5
The branch's excludes no longer reach the size caps: agentic-os#1108 narrowed
them to placement and flatness. mods/docs/FEATURES.md is this repo's prose, so
it is compressed, 49 lines to 39.

Two files remain over the cap and are deliberately untouched, because neither
is this repo's prose to cut:

* unity/Assets/EcoModKit/Docs/README.md is vendored upstream Eco SDK
  documentation, citing wiki.play.eco and Eco 0.9.6 release notes.
* mods/Mods/UserCode/MinesQuarries/README.md is the mod.io listing copy players
  read on the store page.

Both need a carve-out decision before this branch can go green. The existing
exemptions in check_documentation_layout.py are basename (CODE_OF_CONDUCT.md)
and tree (skill roots, the org profile README), so a vendored-tree exemption is
the same shape, but adding one is a change to the doctrine that #1108 set
deliberately and belongs to Kai rather than to this migration.

Co-authored-by: Kai Siren <coilysiren@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
Sign in to join this conversation.
No reviewers
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-gaming/eco-mods!16
No description provided.