Customize a story's documentation slug #30064
rachelholtz
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Is your feature request related to a problem? Please describe.
I find it frustration that I don't have control over the documentation slug for a story.
When setting up documentation for a story, using the API, we have some controls for the documentation page for said story. https://storybook.js.org/docs/api/main-config/main-config-docs
However, it would be nice to have control over what the slug is in the url. For example, if I set the
defaultName
to be "Documentation" for the sidebar to display, I would like to be able to change how this shows up in the url such as?path=/docs/components-name--readme
.This is especially helpful when there are major changes to storybook. We have a lot of links to documentation pages, but if/when Storybook changes how things are set up, we have to change multiple sites to the new url. Would be nice to be able to update one place, Storybook to use the new features but only have to change the slug in one place.
Describe the solution you'd like
In the api, add a configuration under docs that sets the slug string that follows the components meta data,
defaultSlug
/Describe alternatives you've considered
No response
Are you able to assist to bring the feature to reality?
no
Additional context
No response
Beta Was this translation helpful? Give feedback.
All reactions