coilyco-flight-deck/otel-a2a-relay
1
0
Fork 0
Code Issues 12 Pull requests Projects Releases Packages Wiki Activity Actions

chore: split docs over agentic-os documentation-layout caps #12

New issue
Open
opened 2026-05-26 05:23:11 +00:00 by coilysiren · 0 comments
coilysiren commented 2026-05-26 05:23:11 +00:00
Owner
Copy link

Problem

agentic-os v0.2.8 documentation-layout hook now flags 28 violations across README.md, docs/, skills/. Caps are 80 lines / 4000 chars.

Flagged files (counts at time of filing):

  • README.md (146 lines, 11691 chars)
  • docs/FEATURES.md (88 lines, 6386 chars)
  • docs/channels-protocol.md (149 lines, 8095 chars)
  • docs/protocol.md (327 lines, 19010 chars)
  • docs/protocols-survey.md (380 lines, 25395 chars)
  • examples/luca-flow/README.md (101 lines, 5892 chars)
  • skills/ops-eng-o2r-agent-channel/SKILL.md (4253 chars)
  • skills/ops-eng-o2r-grafana/SKILL.md (105 lines, 7164 chars)
  • skills/ops-eng-o2r-phoenix/SKILL.md (4529 chars)
  • tempo_grafana/README.md (120 lines, 7900 chars)

Fix

Split each into smaller flat docs/*.md files; root keeps a short intro pointing at them. Same shape as the AGENTS.md / SKILL.md size discipline.

Out of scope for: coilysiren/otel-a2a-relay#135 (code-comments only). Surfacing as separate sweep so #135 can land with SKIP=documentation-layout for the one commit.

Ported from coilysiren/otel-a2a-relay#136.

**Problem** agentic-os v0.2.8 `documentation-layout` hook now flags 28 violations across README.md, docs/, skills/. Caps are 80 lines / 4000 chars. Flagged files (counts at time of filing): - README.md (146 lines, 11691 chars) - docs/FEATURES.md (88 lines, 6386 chars) - docs/channels-protocol.md (149 lines, 8095 chars) - docs/protocol.md (327 lines, 19010 chars) - docs/protocols-survey.md (380 lines, 25395 chars) - examples/luca-flow/README.md (101 lines, 5892 chars) - skills/ops-eng-o2r-agent-channel/SKILL.md (4253 chars) - skills/ops-eng-o2r-grafana/SKILL.md (105 lines, 7164 chars) - skills/ops-eng-o2r-phoenix/SKILL.md (4529 chars) - tempo_grafana/README.md (120 lines, 7900 chars) **Fix** Split each into smaller flat docs/*.md files; root keeps a short intro pointing at them. Same shape as the AGENTS.md / SKILL.md size discipline. **Out of scope for**: coilysiren/otel-a2a-relay#135 (code-comments only). Surfacing as separate sweep so #135 can land with SKIP=documentation-layout for the one commit. --- _Ported from coilysiren/otel-a2a-relay#136._
coilysiren added
P4
 and removed
P3
 labels 2026-05-31 07:01:05 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
dependabot/uv/uv-e1a0e186ab
No results found.
Labels
Clear labels
  
P0
now / blocking / urgent

  
P1
next / important

  
P2
backlog / will do

  
P3
someday / low

  
P4
icebox / frozen / reopen if it becomes real

No labels
P0
P1
P2
P3
P4
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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/otel-a2a-relay#12
No description provided.