docs(README): Refresh with package list, local setup and link fixes - #4062
Merged
Conversation
m7kvqbe1
requested review from
markhigham,
ollie-sutton and
thyhjwb6
as code owners
June 29, 2026 11:20
ollie-sutton
approved these changes
Jun 29, 2026
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.
Related issue
N/A
Overview
Refreshes the root README, which was last meaningfully updated in Feb 2025 and had broken links and notable gaps. Adds a packages table, real local-development steps, and tidies the badges/links.
Reason
The README didn't list the monorepo packages, never told contributors to run
pnpm installor how to start Storybook, and contained broken/stale links.Work carried out
@royalnavy/*packagesnvm install→corepack enable→pnpm install→ run Storybook on :6006)build/lint/test/storybook:static) and thepnpm --filterpattern for package scriptsgithub.com/design-system/...)https(thehttpURL 301-redirects)Developer notes
docs/CONTRIBUTING.md,LICENSE,.nvmrc).pnpm --filter @royalnavy/react-component-library storybookcommand is verified against the package's scripts.