Split README under the 4000-char documentation-layout cap #274

New issue

Closed

opened 2026-06-24 08:29:54 +00:00 by coilysiren · 0 comments

coilysiren commented

2026-06-24 08:29:54 +00:00

Owner

README.md is 4096 chars at HEAD (excluding any per-issue link additions), over the 4000-char documentation-layout cap. This is pre-existing debt: the cap was tripped by the prior See-also growth (the architecture link in 34a6fd7), not by any single feature.

While that split is pending, README.md is carried in the [tool.agentic-os.documentation-layout] excludes in pyproject.toml (mirroring the docs/hook.md / ward#50 precedent). Drop the exclude once the README is split into smaller docs/*.md files and lands back under the cap.

Filed from ward#254 (the ward vs OpenShell comparison writeup), which added one See-also link to the already-over-cap README.

README.md is 4096 chars at HEAD (excluding any per-issue link additions), over the 4000-char `documentation-layout` cap. This is pre-existing debt: the cap was tripped by the prior See-also growth (the architecture link in 34a6fd7), not by any single feature. While that split is pending, README.md is carried in the `[tool.agentic-os.documentation-layout]` excludes in `pyproject.toml` (mirroring the docs/hook.md / ward#50 precedent). Drop the exclude once the README is split into smaller docs/*.md files and lands back under the cap. Filed from ward#254 (the ward vs OpenShell comparison writeup), which added one See-also link to the already-over-cap README.

coilysiren closed this issue

2026-06-24 15:36:28 +00:00

coilysiren referenced this issue from a commit

2026-07-02 02:36:53 +00:00

docs(readme): regrow the README into the launch-grade front page

coilysiren referenced this issue

2026-07-02 08:03:14 +00:00

front page gives a hostile reader zero context for v0.x + 242 releases + 0 stars/forks #445