Docs: Fix A11y preview configuration example

[jonniebigodes]

Addresses #32731

What I did

With this pull request, the documentation, specifically the A11y project-level configuration snippet, was updated to reflect the correct API and prevent issues when a user attempts to disable the checks manually.

What was done:

• Adjusted the A11y project-level configuration snippet to the correct API (i.e., replacing globals with initialGlobals)

A follow pr targetting the main branch will ensue to ensure parity, as this branch already has CSF next variants

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

• Documentation
  • Updated a11y configuration examples to use the initialGlobals key instead of globals across CSF 3 and CSF Next (JS/TS) variants.
  • Ensures examples align with current configuration practices for initializing Axe settings, reducing confusion for new setups.
  • No behavioral changes; examples reflect the same a11y options with updated property naming.

[coderabbitai]

📝 Walkthrough

Walkthrough

Renames the exported configuration property from globals to initialGlobals in four code blocks within a single documentation snippet for addon accessibility configuration across CSF 3/Next and JS/TS variants. The nested a11y object and manual flag remain unchanged.

Changes

Cohort / File(s)	Summary
Docs snippet updates docs/_snippets/addon-a11y-config-in-preview.md	In four code blocks (CSF 3 JS, CSF 3 TS, CSF Next TS, CSF Next JS), renamed exported property globals → initialGlobals; inner a11y config and manual flag unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs_fix_a11y_project_config_snippet_with_csf4

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a0464b and c09c3ac.

📒 Files selected for processing (1)

• docs/_snippets/addon-a11y-config-in-preview.md (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Update documentation under docs/ for significant changes, including migration guides for breaking changes

Files:

• docs/_snippets/addon-a11y-config-in-preview.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Core Unit Tests, windows-latest

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[nx-cloud]

View your CI Pipeline Execution ↗ for commit eccece2

Command	Status	Duration	Result
nx run-many -t build --parallel=3	✅ Succeeded	45s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-10-15 17:01:51 UTC