Skip to content

docs: README follows agent-skills' layout, with a lifecycle hero - #38

Merged
ttncode merged 1 commit into
mainfrom
docs/readme-agent-skills-layout
Sep 25, 2026
Merged

ttncode merged 1 commit into
mainfrom
docs/readme-agent-skills-layout

Conversation

@ttncode

@ttncode ttncode commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

What this changes

The README follows the layout of addyosmani/agent-skills: a bold tagline, a hero figure, a command table with a key principle per row, what a generated project gets, adapters and services, how it works, project structure, why scaffold, documentation, contributing and a team table. Detail that already lives in docs/ is linked instead of repeated, so the README keeps only what a first-time reader needs.

The hero, docs/diagrams/scaffold-lifecycle.png, shows a client project from scaffold new to a running release, with scaffold update and the nine-task contract. It is drawn with the diagram-design skill in the same default skin as the other diagrams, with its .html source beside it. It is a PNG rather than an SVG because GitHub shows README images without the web fonts an SVG imports. docs/README.md lists it in the diagrams table.

No code or behaviour changes.

How it was verified

  • mise run lint: passes (also ran as the pre-commit hook, with gitleaks: no leaks found).
  • mise run test-runner: exit 0. Unit lane 201 of 201, integration lane 69 of 69, nothing skipped.
  • bats tests/documentation.bats: 5 of 5. Every path named, every relative link and image, and every ADR cited in the new README resolves.

Checklist

  • mise run lint passes
  • mise run test-runner passes
  • New behaviour has a test that fails without the change: not applicable, no behaviour changes
  • Docs that describe changed behaviour were updated in the same commit
  • No unrelated changes

Adopts addyosmani/agent-skills' README shape: bold tagline, a hero
figure, a command table with a key principle per row, what a project
gets, adapters and services, how it works, structure, why, docs,
contributing and team. Detail that lives in docs/ is linked rather than
repeated. The hero is drawn with the diagram-design skill in the same
skin as the other diagrams, as a PNG because GitHub shows README images
without their web fonts.
@ttncode
ttncode merged commit 1a04903 into main Sep 25, 2026
21 of 22 checks passed
@ttncode
ttncode deleted the docs/readme-agent-skills-layout branch September 28, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant