docs: add monorepo and package READMEs#7
Merged
Merged
Conversation
Gnuk
force-pushed
the
5-add-readme
branch
4 times, most recently
from
ce02f8f to
f440e13
Compare
Add a slim root README indexing the published packages, and a consumer-facing README for @ippon-ui/styles, @ippon-ui/react and @ippon-ui/icons (npm install -D, canonical stylesheet imports, usage examples). Replaces the leftover Tikui and Vite scaffold READMEs in styles/ and react/. Bump the three published packages to 0.0.4 to release the new docs. Add the missing `mise build` step to the dev quickstart and to the pick-issue-to-pr skill setup. Refs #5 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.
Closes #5
What
README.mdindexing the three published packages, with themisedevelopment quickstart.@ippon-ui/styles— install, canonical fonts/icons/stylesheet imports, class usage.@ippon-ui/react— install (with@ippon-ui/styles), React 19 peer dep, component example, component list.@ippon-ui/icons— install, consumption viastyles/react, exported icon-name types.Notes
npm install -D: the UI packages are bundled into the consumer's app.styles/README.md(default Tikui scaffold) andreact/README.md(default Vite template) were leftover scaffolding with inaccurate info; they are replaced by the consumer docs.mise styles-dev).🤖 Generated with Claude Code