Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't show docspage unless the user opts in #19627

Merged
merged 14 commits into from
Oct 27, 2022

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Oct 26, 2022

Telescoping on #19625 (and therefore only currently works in v6 store).

What I did

  • DocsPage no longer applies unless the component has the docsPage tag.
  • I added that tag to our docs page stories.
  • Tests
  • Warn on story use?
  • Migration guide

How to test

Run a sandbox, check out all stories compared to docs page stories

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!!

What are the semantics of adding docsPage to an individual story? Error? Warn? Ignore?

@tmeasday
Copy link
Member Author

What are the semantics of adding docsPage to an individual story? Error? Warn? Ignore?

It's ignore at this point. I guess from my perspective it doesn't make sense as the docs are attached to the component, so I wouldn't expect people to do it, but I'm probably too "deep" at this point. We could warn?

@tmeasday tmeasday marked this pull request as ready for review October 26, 2022 07:02
Base automatically changed from tom/sb-829-add-story-tags-to-the-index-index to next October 27, 2022 09:50
@tmeasday tmeasday merged commit 7ead98b into next Oct 27, 2022
@tmeasday tmeasday deleted the tom/sb-831-only-generate-docs-page-for-tagged branch October 27, 2022 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants