docs: README follows agent-skills' layout, with a lifecycle hero - #38
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 fromscaffold newto a running release, withscaffold updateand the nine-task contract. It is drawn with the diagram-design skill in the same default skin as the other diagrams, with its.htmlsource beside it. It is a PNG rather than an SVG because GitHub shows README images without the web fonts an SVG imports.docs/README.mdlists 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 lintpassesmise run test-runnerpasses