Docs: Remove autodocs configuration reference from the documentation

[jonniebigodes]

What I did

With this pull request, the documentation was updated to remove the non-existent autodocs property from the docs configuration object, as it was removed in 9.0.

What was done:

• Adjust the API configuration documentation
• Removed the snippet
• Removed additional references to it in the documentation

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 canary-release-pr.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

• Documentation
  • Removed outdated autodocs examples from configuration snippets and API docs.
  • Updated docs configuration examples to use defaultName and docsMode.
  • Refreshed example defaults (e.g., defaultName now shown as “Docs” in places) and clarified descriptions.
  • Added and showcased docsMode as an available option in examples.
  • Reworked tables and links for clearer navigation to related API references.

[coderabbitai]

Walkthrough

Documentation updates remove the autodocs config examples, replace docs.autodocs with docs.defaultName, add docs.docsMode in snippets, and update API and guide pages accordingly. No runtime or control-flow changes; all edits are to Markdown snippets and docs content.

Changes

Cohort / File(s)	Summary of Changes
Remove autodocs snippet docs/_snippets/main-config-docs-autodocs.md	Deleted JS/TS Storybook config examples demonstrating docs.autodocs: 'tag', removing associated default exports in the snippet.
Config snippets updates docs/_snippets/main-config-typical.md, docs/_snippets/storybook-auto-docs-full-config.md	Replaced docs.autodocs: 'tag' with docs.defaultName: 'Documentation'; added docs.docsMode: true to full config snippet (JS/TS variants reflected).
Docs pages reflecting docs option changes docs/api/main-config/main-config-docs.mdx, docs/configure/index.mdx, docs/writing-docs/autodocs.mdx	Removed autodocs property docs and snippet include; updated config examples to use docs: { defaultName: 'Documentation' }; reformatted Autodocs options table to link defaultName and docsMode, noting default label as 'Docs'.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

• [Documentation]: main-config-docs is probably outdated #32085 — Aligns with removal of autodocs and documentation of defaultName and docsMode in main config docs.

Poem

In burrows of docs I hop and glean,
Tags now gone, new names seen—
“Documentation” bows to “Docs” so clean,
Flip docsMode on, let pages preen.
Thump-thump! I merge this verdant scene—
Carrots and configs, crisp and keen. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly and accurately describes the primary change — removing references to the obsolete "autodocs" docs configuration — and aligns with the PR objectives and the file-level changes in the summary. It is concise, specific, and clear for a teammate scanning repository history.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

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

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

docs/configure/index.mdx (1)

36-36: Update link target to the docs config API page for accuracy.

Linking “docs” to the Autodocs concept page is a bit indirect. Point to the main-config docs API reference instead.

-| `docs`                | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)<br /> `docs: { defaultName: 'Documentation' }`                                                                                                             |
+| `docs`                | Configures Storybook's [docs configuration](../api/main-config/main-config-docs.mdx)<br /> `docs: { defaultName: 'Documentation' }`                                                                                                            |

docs/_snippets/main-config-typical.md (1)

10-11: Standardize example defaultName to match the documented default.

Elsewhere (autodocs.mdx) the default is shown as 'Docs'. Recommend using the same value here for consistency.

-    defaultName: 'Documentation',
+    defaultName: 'Docs',

Apply to both JS and TS snippets.

Also applies to: 28-29

docs/_snippets/storybook-auto-docs-full-config.md (1)

10-11: Align defaultName with the rest of the docs.

Keep docsMode: true. Change defaultName to 'Docs' to match other references.

-    defaultName: 'Documentation',
+    defaultName: 'Docs',

Apply to both JS and TS snippets.

Also applies to: 26-27

docs/writing-docs/autodocs.mdx (1)

60-64: Standardize defaultName to 'Documentation' across docs

docs/writing-docs/autodocs.mdx:62 currently shows defaultName = 'Docs' — change it to 'Documentation' to match other occurrences (e.g. docs/configure/index.mdx:36, docs/_snippets/*).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 488d8bc and 407a388.

📒 Files selected for processing (6)

• docs/_snippets/main-config-docs-autodocs.md (0 hunks)
• docs/_snippets/main-config-typical.md (2 hunks)
• docs/_snippets/storybook-auto-docs-full-config.md (2 hunks)
• docs/api/main-config/main-config-docs.mdx (0 hunks)
• docs/configure/index.mdx (1 hunks)
• docs/writing-docs/autodocs.mdx (1 hunks)

💤 Files with no reviewable changes (2)

• docs/_snippets/main-config-docs-autodocs.md
• docs/api/main-config/main-config-docs.mdx

⏰ 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). (2)

• GitHub Check: Danger JS
• GitHub Check: Core Unit Tests, windows-latest

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 5c42937

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

---

☁️ Nx Cloud last updated this comment at 2025-09-23 11:34:24 UTC