docs: link docs/ from README and fix stale command name#1220
Merged
John-David Dalton (jdalton) merged 1 commit intomainfrom Apr 17, 2026
Merged
docs: link docs/ from README and fix stale command name#1220John-David Dalton (jdalton) merged 1 commit intomainfrom
John-David Dalton (jdalton) merged 1 commit intomainfrom
Conversation
- README now has a "Further Reading" section that points to the guides in docs/ plus each package's README. Makes it discoverable for anyone onboarding from the top-level README. - Fixes a stale command name in docs/build-guide.md: `pnpm run clean-cache` → `pnpm run clean:cache` (matches the actual package.json script name). - Also corrects `pnpm clean` → `pnpm run clean` in the same block.
Bill Li (billxinli)
approved these changes
Apr 17, 2026
John-David Dalton (jdalton)
deleted the
docs/link-docs-and-fix-command-name
branch
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
2 participants
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
docs/build-guide.md,docs/bundle-tools.md, and each package's README so a new contributor can find the deeper docs from the landing page.docs/build-guide.md—pnpm run clean-cache→pnpm run clean:cache(the actualpackage.jsonscript uses a colon). Same block:pnpm clean→pnpm run clean.Test plan
pnpm run clean:cacheexists in root package.jsonNote
Low Risk
Documentation-only changes; no runtime behavior, build logic, or shipped artifacts are modified.
Overview
Adds a Further Reading section to the root
README.md, linking to key internal docs (docs/*) and package-level READMEs to make contributor documentation easier to discover.Updates
docs/build-guide.mdto fix stale cache/clean command examples (clean-cache→clean:cache, andpnpm clean→pnpm run clean).Reviewed by Cursor Bugbot for commit 6659017. Configure here.