Docs: Add docs for story tags #26715
Conversation
- API reference - Guide - CLI options
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 974ad92. 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 targetSent with 💌 from NxCloud. |
- Document new API - Add examples - Remove `main-config-tags` - Remove `--tags` and `--exclude-tags` CLI flags - Remove `autodocs: true | false | 'tag'` - Remove old snippets
|
Note: let's wait to merge until the tags PR gets merged |
@shilman — Should I just update the target branch to yours? |
|
@kylegach SGTM! |
docs/writing-stories/tags.md
Outdated
|
|
||
| ## Applying tags | ||
|
|
||
| A tag can be any string, either the [built-in tags](#built-in-tags) or custom tags of your own design. To apply tags to a story, assign an array of strings to the `tags` property. Tags may be applied at the project, component (meta), or story levels. |
There was a problem hiding this comment.
I think it's important to point out the limitation on tags being static. Eg. no template strings, no concatenation, no dynamic creation, etc.
@shilman will know the exact details but AFAIK nothing besides a plain string is supported
There was a problem hiding this comment.
@JReinhold — How's this?
- Clarify static nature of tags
What I did
Documented the newly-official
tagsAPI in #26634Checklist for Contributors
Testing
Manual testing
tags-docshttp://localhost:8000/docs/writing-stories/tagshttp://localhost:8000/docs/writing-docs/autodocsDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>