Docs: Add details for React version used by addon-docs #25550
Merged
Conversation
This file contains 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
kylegach
added
documentation
ci:docs
jonniebigodes
approved these changes
Jan 11, 2024
There was a problem hiding this comment.
Thanks for taking care of this @kylegach. Appreciate it. I'm going to approve this to unblock you, as I only have one question regarding this pull request.
kylegach
force-pushed
the
docs-no-react-peer-for-addon-docs
branch
from
85a2a0b
to
e705dfa
Compare
kylegach
commented
Jan 16, 2024
| @@ -459,7 +459,16 @@ If you're still encountering issues, we recommend reaching out to the community | |||
|
|
|||
| If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |||
|
|
|||
| #### Learn more about Storybook documentation | |||
| ### The React version used is unexpected | |||
There was a problem hiding this comment.
@JReinhold — Does this look like sufficient documentation?
chantastic
approved these changes
Jan 18, 2024
JReinhold
approved these changes
Jan 18, 2024
| @@ -459,7 +459,16 @@ If you're still encountering issues, we recommend reaching out to the community | |||
|
|
|||
| If you turned off inline rendering for your stories via the [`inline`](../api/doc-block-story.md#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release. | |||
|
|
|||
| #### Learn more about Storybook documentation | |||
| ### The React version used is unexpected | |||
- Use bold text instead of heading
- The correct heading level is often h2, which is much more attention grabbing than we want
- Using a better heading level size, h4, is often incorrect, semantically
- h4's styles are just bold normal text
- There's no value in having these headings in the "On this page" TOCs, because it's just duplicating what's in the sidebar navigation
kylegach
force-pushed
the
docs-no-react-peer-for-addon-docs
branch
from
e705dfa
to
4267381
Compare
18 tasks
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.
What I did
Checklist for Contributors
Testing
Manual testing
docs-no-react-peer-for-addon-docsDocumentation
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>