Skip to content
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

Docs: Add streamlined a11y setup docs #29296

Merged
merged 4 commits into from
Oct 9, 2024
Merged

Conversation

shilman
Copy link
Member

@shilman shilman commented Oct 8, 2024

We should be pushing users onto storybook add everywhere. This should:

  1. Automatically install the correct version based on the version of Storybook they are using
  2. Add it to both package.json and main.js today, and in the future add it to preview.ts
  3. Run an addon-speciific postinstall script if it exists (e.g. @storybook/addon-test configures Vitest)

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR streamlines the installation process for the Storybook accessibility addon (@storybook/addon-a11y) by introducing the 'storybook add' command, simplifying setup and ensuring version compatibility.

  • Updated docs/_snippets/storybook-a11y-add.md with new 'storybook add' command for npm, pnpm, and yarn
  • Removed docs/_snippets/storybook-a11y-register.md, eliminating manual addon registration
  • Modified docs/writing-tests/accessibility-testing.mdx to reflect simplified addon setup process
  • Improved documentation flow and removed redundant information in accessibility testing guide

@shilman shilman added documentation addon: a11y ci:docs Run the CI jobs for documentation checks only. labels Oct 8, 2024
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

3 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Oct 8, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d071ee9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

All good on my end. I've polished it up a bit and will merge this once the checklist clears. Thank you for taking the time to update the documentation and streamline the instructions. Appreciate it 🙏

@jonniebigodes jonniebigodes merged commit e660a1a into next Oct 9, 2024
9 checks passed
@jonniebigodes jonniebigodes deleted the shilman/improve-a11y-install branch October 9, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: a11y ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants