Skip to content

docs: MVP-α consumer landing page + quickstart#6200

Open
caseyisonit wants to merge 3 commits intomainfrom
caseyisonit/docs-mvp-alpha-consumer-landing
Open

docs: MVP-α consumer landing page + quickstart#6200
caseyisonit wants to merge 3 commits intomainfrom
caseyisonit/docs-mvp-alpha-consumer-landing

Conversation

@caseyisonit
Copy link
Copy Markdown
Contributor

Summary

Adds the first consumer-facing docs path for 2nd-gen Spectrum Web Components. Lands a Get started landing page authored in Markdown under CONTRIBUTOR-DOCS/for-consumers/get-started.md and wires it into the Storybook sidebar as the first entry. This also seeds the consumer-quickstart template used by subsequent consumer guides.

Stack position: 1 of 7 — base for this PR is main.

Part of the docs-overhaul-v2 rollout. See RFC: CONTRIBUTOR-DOCS/rfcs/proposed/2026-04-22-docs-overhaul-v2.md.

Motivation

/2nd-gen/README.md was 25 lines and only pointed back to CONTRIBUTOR-DOCS. A consumer who wanted to use <swc-badge> in their app had nowhere to land. This PR closes the #1 consumer gap with a real "hello world" — install, first component, framework note, where to go next.

Related

  • Addresses MVP-α in the approved docs-overhaul-v2 plan
  • Supersedes 2nd-gen/packages/swc/.storybook/guides/customization/getting-started.mdx for the onboarding path (the stylesheet-setup content is folded into the new quickstart)

Accessibility testing checklist

Docs-only change — no interactive component surface affected.

  • Keyboard — no new focusable components added; existing Storybook navigation unchanged.
  • Screen reader — headings, lists, and code blocks render as semantic markdown.

🤖 Generated with Claude Code

@caseyisonit caseyisonit requested a review from a team as a code owner April 24, 2026 18:57
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 24, 2026

⚠️ No Changeset found

Latest commit: 6f24dd1

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
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

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

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.

@caseyisonit caseyisonit added Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. Status:Ready for review PR ready for review or re-review. labels Apr 24, 2026
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

basic placeholder getting started, yes you will see the old one still in side bar, this is an iterative evolution so i will not be removing the old on in this PR that will come later.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

basic place holder for consumer get started guide. this will change in the final PR of this merge queue when CONTRIBUTOR-DOCS is re-architected to audience based structure.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

basic entry point with linking the audience to their next page

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

template to use for future consumer guides if needed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

for some reason these links were broken so replaced with forth coming since this is an old artifact

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant