Skip to content

Conversation

@marissahuysentruyt
Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt commented Nov 10, 2025

Description

Updated the CONTRIBUTOR-DOCS link in the 2nd-gen welcome guide to point to the main branch instead of the barebones branch. The link was previously pointing to our now-merged and deleted barebones branch.

Screen.Recording.2025-11-11.at.2.54.31.PM.mov

Motivation and context

The welcome guide for 2nd-gen SWC contained a broken link that pointed to the barebones branch. Since the CONTRIBUTOR-DOCS are maintained on the main branch now, this link needed to be updated to ensure contributors can access the correct documentation.

Related issue(s)

  • fixes SWC-1358

Screenshots (if appropriate)

N/A - Documentation link fix only


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
    Note: This is a minor documentation fix that updates a single link reference. No changeset is required as it doesn't affect published packages.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • Verify the CONTRIBUTOR-DOCS link is accessible

    1. Navigate to the 2nd-gen Storybook welcome guide. Because this is a second-gen issue, you may have to run this locally to test.
    2. Click on the CONTRIBUTOR-DOCS link
Screenshot 2025-11-11 at 2 50 29 PM
3. Expect to land on the main branch CONTRIBUTOR-DOCS README at https://github.com/adobe/spectrum-web-components/tree/main/CONTRIBUTOR-DOCS/README.md. The link shouldn't 404 like it does on main.

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

@marissahuysentruyt marissahuysentruyt self-assigned this Nov 10, 2025
@changeset-bot
Copy link

changeset-bot bot commented Nov 10, 2025

⚠️ No Changeset found

Latest commit: 2cf9eee

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 10, 2025

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5872

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@marissahuysentruyt marissahuysentruyt added the Documentation Issues or PRs involving changes to documentation or documentation website label Nov 11, 2025
@marissahuysentruyt marissahuysentruyt marked this pull request as ready for review November 11, 2025 16:36
@marissahuysentruyt marissahuysentruyt requested a review from a team as a code owner November 11, 2025 16:36
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/fix-contributor-docs-link branch from e6a0303 to 2cf9eee Compare November 11, 2025 19:47
Copy link
Collaborator

@pfulton pfulton left a comment

Choose a reason for hiding this comment

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

LGTM

@pfulton pfulton merged commit 977d6de into main Nov 12, 2025
22 checks passed
@pfulton pfulton deleted the marissahuysentruyt/fix-contributor-docs-link branch November 12, 2025 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Issues or PRs involving changes to documentation or documentation website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants