coilysiren/cli-web-docs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: clean up documentation-layout violations (agentic-os v0.2.8) #3

New issue
Closed
opened 2026-05-26 03:27:30 +00:00 by coilysiren · 0 comments
coilysiren commented 2026-05-26 03:27:30 +00:00
Owner
Copy link

Problem

Bumping the agentic-os pre-commit suite to v0.2.8 (closes coilysiren/cli-web-docs#41) surfaces existing documentation-layout / catalog-doc-size violations unrelated to the code-comments cleanup:

  • examples/README.md, examples/custom-theme/README.md, examples/deep-tree/README.md, examples/multi-page/README.md, examples/render/README.md - Markdown files outside the allow-list (repo root, docs/*.md, or skill folders).
  • CODE_OF_CONDUCT.md (5121 chars) exceeds the 4000-char cap; docs/CODE_OF_CONDUCT.md is a duplicate at the same size.

Fix

  • Pick one canonical CoC location and split / link out the body to fit the 4000-char cap. Drop the duplicate.
  • For each examples/*/README.md: delete (godoc already documents the demo) or migrate into docs/examples-<name>.md and link from docs/examples.md.

Verify:

pre-commit run documentation-layout --all-files
pre-commit run catalog-doc-size --all-files

Context

Skipped via SKIP env when landing coilysiren/cli-web-docs#41.

**Problem** Bumping the agentic-os pre-commit suite to v0.2.8 (closes coilysiren/cli-web-docs#41) surfaces existing `documentation-layout` / `catalog-doc-size` violations unrelated to the code-comments cleanup: - `examples/README.md`, `examples/custom-theme/README.md`, `examples/deep-tree/README.md`, `examples/multi-page/README.md`, `examples/render/README.md` - Markdown files outside the allow-list (repo root, `docs/*.md`, or skill folders). - `CODE_OF_CONDUCT.md` (5121 chars) exceeds the 4000-char cap; `docs/CODE_OF_CONDUCT.md` is a duplicate at the same size. **Fix** - Pick one canonical CoC location and split / link out the body to fit the 4000-char cap. Drop the duplicate. - For each `examples/*/README.md`: delete (godoc already documents the demo) or migrate into `docs/examples-<name>.md` and link from `docs/examples.md`. Verify: ``` pre-commit run documentation-layout --all-files pre-commit run catalog-doc-size --all-files ``` **Context** Skipped via SKIP env when landing coilysiren/cli-web-docs#41.
coilysiren 2026-06-17 08:24:06 +00:00
Commenting is not possible because the repository is archived.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
burndown-2026-06
Backlog burndown June 2026

  
icebox
Closed in the 2026-05-29 backlog burn-down; reopen if it becomes real

  
P0
now / blocking / urgent

  
P1
next / important

  
P2
backlog / will do

  
P3
someday / low

  
P4
P4

No labels
burndown-2026-06
icebox
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
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
coilysiren/cli-web-docs#3
No description provided.