Skip to content

chore: update outdated spectrum CSS doc URLs #5575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

saashapina
Copy link
Collaborator

@saashapina saashapina commented Jun 26, 2025

Description

Updated outdated Spectrum CSS doc URLs

Motivation and context

SWC-920

Previously, the Spectrum CSS team removed their standalone docs site in favor of using Storybook exclusively. This means that older documentation URLs (e.g.,
https://opensource.adobe.com/spectrum-css/typography.html) are now deprecated and should be replaced with the new Storybook-based format, such as:
or https://opensource.adobe.com/spectrum-css/?path=/docs/components-typography--docs

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

@saashapina saashapina requested a review from a team as a code owner June 26, 2025 12:51
Copy link

changeset-bot bot commented Jun 26, 2025

⚠️ No Changeset found

Latest commit: f4b4ab7

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

@saashapina saashapina self-assigned this Jun 26, 2025
Copy link

github-actions bot commented Jun 26, 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-5575

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.

Copy link

Tachometer results

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

Copy link
Contributor

@castastrophe castastrophe left a comment

Choose a reason for hiding this comment

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

Wow! Did you manually update this?! This used to be auto-generated. 👩‍🍳 💋

Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

As @castastrophe mentioned, it seems like we did indeed previously have a script for this (see #1987) but I'm guessing we removed it during cutover because it referenced the config.js files that we removed at that time. That might be a nice thing to bring back and try to update at some point, but not necessarily here!

Otherwise just calling out a few formatting adjustments that need to be made and some components whose circumstances have changed a bit.

INVENTORY.md Outdated
| meter | ✅ | | |
| miller | | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-miller--docs) | ❌ |
| millercolumn | ✅ | | |
| modal | | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-modal--docs) | [📄](https://opensource.adobe.com/spectrum-web-components/components/modal) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again, out of scope but the SWC link doesn't work 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm I dont seem to see a modal component at all in SWC. I went ahead and removed this.

@saashapina saashapina force-pushed the saasha/update-outdated-doc-urls branch from 2f5e5d9 to f4b4ab7 Compare July 2, 2025 13:07
@saashapina saashapina requested a review from rise-erpelding July 2, 2025 14:06
Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

I found one more swc link that doesn't work, otherwise though this is good to go! Special thanks to Cursor for helping me validate every link!!

| tooltip | ✅ | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-tooltip--docs) | [📄](https://opensource.adobe.com/spectrum-web-components/components/tooltip) |
| tray | ✅ | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-tray--docs) | [📄](https://opensource.adobe.com/spectrum-web-components/components/tray) |
| treeview | ✅ | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-tree-view--docs) | ❌ |
| typography | | [📄](https://opensource.adobe.com/spectrum-css/?path=/docs/components-typography--docs) | [📄](https://opensource.adobe.com/spectrum-web-components/components/styles) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

3 participants