spectrum-web-components icon indicating copy to clipboard operation
spectrum-web-components copied to clipboard

docs: 2nd gen component analysis

Open rise-erpelding opened this issue 2 months ago • 5 comments

Description

Creates AI-generated migration documentation to analyze component differences to guide SWC migration to S2, with human vetting. The documentation serves as a bridge between the migrated Spectrum 2 CSS work and the corresponding web components, in order to help engineers understand what needs to be implemented, updated, or aligned between the two systems to guide the development of 2nd generation web components.

Motivation and context

Related issue(s)

  • fixes [Issue Number]

Screenshots (if appropriate)


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.
  • [ ] 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
  • [ ] Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • [ ] Automated tests cover all use cases and follow best practices for writing
  • [ ] Validated on all supported browsers
  • [ ] All VRTs are approved before the author can update Golden Hash

Manual review test cases

  • [ ] Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result
  • [ ] Descriptive Test Statement

    1. Go here
    2. Do this action
    3. Expect this result

Device review

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

rise-erpelding avatar Oct 01 '25 21:10 rise-erpelding

⚠️ No Changeset found

Latest commit: 7e7651f0bcc3358703dec127a1c5df44b2fc2aca

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

changeset-bot[bot] avatar Oct 01 '25 21:10 changeset-bot[bot]

📚 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-5770

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.

github-actions[bot] avatar Oct 01 '25 21:10 github-actions[bot]

Tachometer results

Currently, no packages are changed by this PR...

github-actions[bot] avatar Oct 01 '25 21:10 github-actions[bot]

@rise-erpelding @marissahuysentruyt if yall want to update this PR out of draft, we can review this and get it merged in. The contributing docs PR has been merged in to barebones.

caseyisonit avatar Oct 24 '25 16:10 caseyisonit

📚 Branch Preview Links

🔍 First Generation 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-5770

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.

github-actions[bot] avatar Dec 10 '25 21:12 github-actions[bot]