Skip to content

docs: fix ADR 017 cross-reference and typos in contributor docs - #8568

Open
toyeshhm wants to merge 1 commit into
primer:mainfrom
toyeshhm:fix-doc-typos
Open

toyeshhm wants to merge 1 commit into
primer:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

Copy link
Copy Markdown

Fixes a broken cross-reference in ADR 017 and a handful of typos in the contributor docs.

ADR 017 says it supersedes ADR 009 and links to ./adr-009-interaction-tests.md, which doesn't exist. ADR 009 is adr-009-behavior-isolation.md; the ADR that 017 actually revisits is ADR 008 (adr-008-interaction-tests.md, the Storybook play-functions one), which already says it is superseded by ADR 017. This updates the number and link, plus the "In ADR 009, we proposed using Storybook's play functions" line further down.

Changelog

New

None.

Changed

  • adrs/adr-017-interaction-tests-revisited.md: ADR 009 -> ADR 008 (link and in-text reference), supercedes -> supersedes
  • adrs/adr-008-interaction-tests.md: superceded -> superseded
  • adrs/adr-018-responsive-values.md: tha twill -> that will
  • adrs/adr-011-snapshot-tests.md: Is is then -> It is then
  • adrs/adr-004-children-as-api.md, adrs/adr-020-live-regions.md: doubled a a / an an
  • CONTRIBUTING.md: everytime -> every time

Removed

None.

Rollout strategy

  • No changes needed in github/github-ui
  • Needs changes in github/github-ui
  • Ships with feature flag(s)
  • Not sure
  • None — changes are limited to contributor-docs/, nothing is published, so no changeset.

Testing & Reviewing

Docs only. The new ADR 017 link resolves to contributor-docs/adrs/adr-008-interaction-tests.md.

ADR 017 said it supersedes ADR 009 and linked to
./adr-009-interaction-tests.md, which does not exist. ADR 009 is
behavior-isolation; the ADR it actually supersedes is ADR 008
(adr-008-interaction-tests.md), which already points back at ADR 017.
Correct the number and link, and the matching "In ADR 009" reference
later in the same document.

Also fix:
- supercedes/superceded -> supersedes/superseded (ADR 017, ADR 008)
- "tha twill" -> "that will" (ADR 018)
- "Is is then" -> "It is then" (ADR 011)
- doubled "a a" and "an an" (ADR 004, ADR 020)
- "everytime" -> "every time" (CONTRIBUTING.md)
Copilot AI balanced review requested due to automatic review settings October 17, 2026 00:09
@toyeshhm
toyeshhm requested a review from a team as a code owner October 17, 2026 00:09
@toyeshhm
toyeshhm requested a review from llastflowers October 17, 2026 00:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@changeset-bot

changeset-bot Bot commented Oct 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 81d8dd0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

This branch was successfully deployed

1 active deployment
github-pages — 81d8dd04 Deployed Oct 17, 2026 by toyeshhm via deploy-preview #30041
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants