Docs: Add TableOfContents API reference page#33934
Merged
valentinpalkovic merged 5 commits intoMar 3, 2026
Merged
Conversation
Co-authored-by: valentinpalkovic <5889929+valentinpalkovic@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for TableOfContents usage in Storybook
docs: Add TableOfContents API reference page
Feb 25, 2026
Copilot stopped work on behalf of
valentinpalkovic due to an error
February 25, 2026 15:17
Contributor
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new TableOfContents documentation page and a corresponding entry in the doc-blocks overview; updates sidebar ordering of several existing doc-block pages to accommodate the new entry. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Comment |
jonniebigodes
approved these changes
Feb 26, 2026
Contributor
jonniebigodes
left a comment
There was a problem hiding this comment.
@valentinpalkovic thanks for addressing this and add the documentation 🙏 ! Left a couple of small items to be looked into.
Approving to unblock you
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
8 tasks
15 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TableOfContentshas been available in@storybook/addon-docssince v7 but had no dedicated API documentation, leaving users confused about correct usage (particularly the common mistake of dropping<TableOfContents />directly into MDX instead of usingparameters.docs.toc).Changes
New
/docs/api/doc-blocks/doc-block-tableofcontents.mdx— Full API reference covering:TableOfContentsis enabled (viaparameters.docs.toc, not direct MDX placement)tocparameter options with types, defaults, and descriptions:contentsSelector,disable,headingSelector,ignoreSelector,title,unsafeTocbotOptionsstorybook-preview-enable-toc.md,storybook-preview-custom-toc.md,my-component-disable-toc.md)/docs/writing-docs/doc-blocks.mdx— AddedTableOfContentsentry to the "Available blocks" section (alphabetically between Subtitle and Title), with theparameters.docs.tocnamespace calloutSidebar ordering — Bumped order numbers for Title (14→15), Typeset (15→16), Unstyled (16→17), useOf (17→18) to accommodate
TableOfContentsat position 14Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.
Summary by CodeRabbit