Skip to content

docs: add stackblitz how-to documentation#6016

Merged
rise-erpelding merged 1 commit intomainfrom
rise-erpelding/stackblitz-docs
Feb 11, 2026
Merged

docs: add stackblitz how-to documentation#6016
rise-erpelding merged 1 commit intomainfrom
rise-erpelding/stackblitz-docs

Conversation

@rise-erpelding
Copy link
Collaborator

@rise-erpelding rise-erpelding commented Feb 10, 2026

Description

Adds a new contributor guide for maintaining StackBlitz examples used by the Spectrum Web Components library.

  • New doc: CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.md
    • StackBlitz terminology (project, collection, workspace)
    • Access: how to get SWC-Team workspace access
    • Adding new projects and adding existing projects to the Spectrum Web Components collection (including fork-to-workspace steps)
    • Naming conventions (swc-component-name pattern)
    • Replacing an existing project in the collection
  • Contributor docs navigation updated via update-nav.js so the new guide appears under Contributor guides (breadcrumbs and “Beneath this doc” TOC).

Motivation and context

Provides the team with a single reference for updating StackBlitz examples, managing the shared collection, and onboarding others (who to ask for access, where to fork, how to add to the collection). Keeps process and naming consistent.

Related issue(s)

  • SWC-1354

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed 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

  • New guide is discoverable from CONTRIBUTOR-DOCS root and nav renders

    1. Open CONTRIBUTOR-DOCS/README.md and confirm “Maintaining StackBlitz examples for Spectrum Web Components” appears under “Beneath this doc” (nested under Contributor guides).
    2. Open CONTRIBUTOR-DOCS/01_contributor-guides/README.md and confirm the same guide appears under “Beneath this doc.”
    3. Open CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.md and confirm breadcrumbs and “In this doc” TOC render correctly.
    4. Expect: The doc is findable from the root contributor docs index and has correct generated navigation.
  • Doc is clear, valuable, and helpful to a human who needs it

    1. Read through CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.md in full as if you need to update a StackBlitz example or get access.
    2. Confirm the terminology, access steps, fork/add-to-collection steps, and naming conventions are understandable and actionable without prior context.
    3. Expect: A teammate could follow this guide to get access, add or replace a project in the collection, and name it correctly.

Device review

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

@changeset-bot
Copy link

changeset-bot bot commented Feb 10, 2026

⚠️ No Changeset found

Latest commit: d7ab69b

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

@rise-erpelding rise-erpelding added the Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. label Feb 10, 2026
@rise-erpelding rise-erpelding marked this pull request as ready for review February 10, 2026 19:25
@rise-erpelding rise-erpelding requested a review from a team as a code owner February 10, 2026 19:25
@rise-erpelding rise-erpelding added the Status:Ready for review PR ready for review or re-review. label Feb 10, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 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-6016

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
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

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

This looks awesome! ✨

@rise-erpelding rise-erpelding added Status:Ready for merge PR has 2 approvals, all tests pass, and is ready to merge and removed Status:Ready for review PR ready for review or re-review. labels Feb 11, 2026
@rise-erpelding rise-erpelding force-pushed the rise-erpelding/stackblitz-docs branch from 6180178 to d7ab69b Compare February 11, 2026 18:50
@rise-erpelding rise-erpelding merged commit 9ffd7cf into main Feb 11, 2026
21 checks passed
@rise-erpelding rise-erpelding deleted the rise-erpelding/stackblitz-docs branch February 11, 2026 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. Status:Ready for merge PR has 2 approvals, all tests pass, and is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants