Repository navigation
docs: format the README install section and regenerate its site page - #23
Merged
Merged
Conversation
The README edit on main left a trailing space (Prettier check fails) and the generated installation page out of date (docs:pages check fails), so CI on main was red.
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.
Fixes CI on
mainafter the commit "Update npm installation instructions in README" (f49db2c).That commit left two things that fail CI:
# From npm, which fails the Prettier check (format:check);docs/guide/installation.mdis generated from the README and still said "(once published)", which fails thedocs:pagesdiff check.This PR removes the space and regenerates the page. No functional change.
To avoid this next time: after editing the README, run
npx prettier --write README.md && npm run docs:pages(see CONTRIBUTING).Generated by Claude Code