docs(readme): ELI5 + visible skills + Tsumagoi (v1.12.0)#12
Merged
Conversation
…2.0) - ELI5 opener with use-case table and ASCII workflow loop (replaces mermaid) - Always-visible family counts + full skill tables (no collapsed details) - Playful Tsumagoi Work&Camp ad; skill list moved above Quick Start
There was a problem hiding this comment.
Pull request overview
Updates the repository’s npm/GitHub-facing documentation to improve readability/discoverability (no Mermaid rendering issues on npm, always-visible skill inventory) and bumps the release to v1.12.0, including updating the README skill-index generator to match the new layout.
Changes:
- Reworked
README.mdto add an ELI5 intro + use-case table, replace Mermaid with an ASCII loop diagram, and ensure skill families + full skill lists are always visible. - Updated
scripts/generate-skill-index.mjsto emit a family counts table and per-family markdown tables (instead of collapsed<details>blocks), and to report totals accordingly. - Bumped versions and documented the release in
CHANGELOG.md,package.json, and.cursor-plugin/plugin.json.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate-skill-index.mjs | Generates a visible family-counts table plus per-family skill tables for README injection. |
| README.md | Restructures and rewrites README for npm-safe rendering and improved onboarding/discoverability. |
| package.json | Bumps package version to 1.12.0. |
| CHANGELOG.md | Adds 1.12.0 release notes describing the README/index changes. |
| .cursor-plugin/plugin.json | Bumps plugin version to 1.12.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Addresses live npm README feedback:
Test plan
npm test