Skip to content

docs(README): Refresh with package list, local setup and link fixes - #4062

Merged
m7kvqbe1 merged 1 commit into
masterfrom
docs/readme-refresh
Jun 29, 2026
Merged

docs(README): Refresh with package list, local setup and link fixes#4062
m7kvqbe1 merged 1 commit into
masterfrom
docs/readme-refresh

Conversation

@m7kvqbe1

Copy link
Copy Markdown
Collaborator

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 install or how to start Storybook, and contained broken/stale links.

Work carried out

  • Added a Packages table covering all five @royalnavy/* packages
  • Added proper Developing locally steps (clone → nvm installcorepack enablepnpm install → run Storybook on :6006)
  • Documented root scripts (build/lint/test/storybook:static) and the pnpm --filter pattern for package scripts
  • Fixed the broken license badge link (was github.com/design-system/...)
  • Switched Storybook links to https (the http URL 301-redirects)
  • Removed dead classic project-board links (GitHub sunset classic Projects)
  • Removed a broken Chromatic logo image; added a Conventions section (Conventional Commits, Husky, Prettier)

Developer notes

  • All internal links verified to resolve (packages, docs/CONTRIBUTING.md, LICENSE, .nvmrc).
  • The pnpm --filter @royalnavy/react-component-library storybook command is verified against the package's scripts.
  • Package descriptions are accurate to each package's contents (e.g. design-tokens covers colour/spacing/typography/breakpoints).

@m7kvqbe1 m7kvqbe1 self-assigned this Jun 29, 2026
@m7kvqbe1 m7kvqbe1 added the Type: Enhancement New feature or request label Jun 29, 2026
@m7kvqbe1
m7kvqbe1 merged commit 1c9a935 into master Jun 29, 2026
14 of 15 checks passed
@m7kvqbe1
m7kvqbe1 deleted the docs/readme-refresh branch June 29, 2026 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants