Rewrite README: clearer, more accurate, more useful#10
Merged
Conversation
- Fix stale/incorrect content: removed the fictional impeccable `detect` command and the `teach` step (now: writes PRODUCT.md directly + runs audit/critique), added PRODUCT.md to the generated file tree, dropped the stale examples/ roadmap item. - Beautify: centered hero + badge row (CI, license, skill, no-build), a collapsible table of contents, a 30-second prompt-to-running example, an ASCII of the signature control bar, and a "generic vs this skill" table. - Add a "Quality system" section surfacing the benchmark (output / overflow / design / context-cost) and the new CI workflow — a real differentiator. - Tighten phases, usage, principles; keep everything current with main. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Refreshes the README to be both prettier and correct after the recent skill changes.
Accuracy fixes (it was advertising things that don't exist)
impeccable detectcommand and theteachstep — the flow now writesPRODUCT.mddirectly and runsaudit+critique.PRODUCT.mdto the generated-prototype file tree.examples/roadmap item.Beautification
New: a "Quality system" section
Surfaces the benchmark (output quality / 390px overflow / design taste / context cost) and the CI workflow — the self-checking machinery we built, which is a genuine differentiator and was previously invisible in the README.
No code touched; CI should stay green.