Migrate docs to the 80-line / 4000-char cap #17

New issue

Closed

opened 2026-05-27 19:54:03 +00:00 by coilysiren · 1 comment

coilysiren commented

2026-05-27 19:54:03 +00:00

Owner

Problem

Pre-commit hooks documentation-layout and code-comments (from coilysiren/agentic-os) fail on this repo's baseline. Any commit is blocked until the migration lands.

Concrete failures from the latest pre-commit run:

8 files over the 80-line / 4000-char cap: docs/channels-protocol.md, docs/protocol.md, docs/protocols-survey.md, examples/luca-flow/README.md, skills/ops-eng-o2r-agent-channel/SKILL.md, skills/ops-eng-o2r-grafana/SKILL.md, skills/ops-eng-o2r-phoenix/SKILL.md, tempo_grafana/README.md.
Location-rule violations for workspace-member READMEs at depth 1 (core/README.md, arize_phoenix/README.md, tempo_grafana/README.md, channels/README.md, arize_phoenix/docker/README.md) and for auto-generated artifacts under examples/luca-flow/tests/snapshots/ and core/tests/fixtures/trace_zoo/.
code-comments flags .claude/lockdown-deny.sh (resolved automatically once the pinned agentic-os rev bumps to v0.3.0, which adds .claude to the skip dirs).

Change

Bump the pinned coilysiren/agentic-os pre-commit rev to v0.3.0 (already unstaged in the working tree).
Add [tool.agentic-os.documentation-layout] excludes in pyproject.toml for workspace-member READMEs and generated test artifacts.
Split the three oversized docs/*.md files into multiple flat docs with filename prefixes.
Trim or split the three oversized skills/*/SKILL.md files, using peer .md files inside each skill folder for overflow detail.
Trim examples/luca-flow/README.md and tempo_grafana/README.md under cap, pushing overflow detail into docs/.

**Problem** Pre-commit hooks `documentation-layout` and `code-comments` (from coilysiren/agentic-os) fail on this repo's baseline. Any commit is blocked until the migration lands. Concrete failures from the latest pre-commit run: - 8 files over the 80-line / 4000-char cap: `docs/channels-protocol.md`, `docs/protocol.md`, `docs/protocols-survey.md`, `examples/luca-flow/README.md`, `skills/ops-eng-o2r-agent-channel/SKILL.md`, `skills/ops-eng-o2r-grafana/SKILL.md`, `skills/ops-eng-o2r-phoenix/SKILL.md`, `tempo_grafana/README.md`. - Location-rule violations for workspace-member READMEs at depth 1 (`core/README.md`, `arize_phoenix/README.md`, `tempo_grafana/README.md`, `channels/README.md`, `arize_phoenix/docker/README.md`) and for auto-generated artifacts under `examples/luca-flow/tests/snapshots/` and `core/tests/fixtures/trace_zoo/`. - `code-comments` flags `.claude/lockdown-deny.sh` (resolved automatically once the pinned agentic-os rev bumps to v0.3.0, which adds `.claude` to the skip dirs). **Change** - Bump the pinned `coilysiren/agentic-os` pre-commit rev to v0.3.0 (already unstaged in the working tree). - Add `[tool.agentic-os.documentation-layout]` excludes in `pyproject.toml` for workspace-member READMEs and generated test artifacts. - Split the three oversized `docs/*.md` files into multiple flat docs with filename prefixes. - Trim or split the three oversized `skills/*/SKILL.md` files, using peer `.md` files inside each skill folder for overflow detail. - Trim `examples/luca-flow/README.md` and `tempo_grafana/README.md` under cap, pushing overflow detail into `docs/`.

coilysiren referenced this issue

2026-05-27 20:11:38 +00:00

Restructure README.md and AGENTS.md for the v0.5.0 agentic-os ruleset #18

coilysiren commented

2026-05-30 05:44:02 +00:00

Author

Owner

Merged into #12 in the 2026-05-29 backlog burn-down. Same doc-cap migration as #12 Reopen if it should stand alone.

coilysiren closed this issue

2026-05-30 05:44:02 +00:00

coilysiren added the

label