-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Docs: Changes corresponding to docs design updates #24925
Conversation
a9f1a80
to
049bed3
Compare
049bed3
to
48fe4e3
Compare
@@ -8,13 +8,13 @@ Storybook Addon Actions can be used to display data received by event handlers i | |||
|
|||
## Installation | |||
|
|||
Actions is part of [essentials](https://storybook.js.org/docs/react/essentials/introduction) and so is installed in all new Storybooks by default. If you need to add it to your Storybook, you can run: | |||
Actions is part of [essentials](https://storybook.js.org/docs/react/essentials) and so is installed in all new Storybooks by default. If you need to add it to your Storybook, you can run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kylegach, one small item here. I suggest removing the framework in the links for our addons and providing with the installation process. Reasoning here: if the reader checks this but is working with Vue or has checked our Vue docs, they should not see a framework that's not his own. This leads him to have to go up the page and select another renderer just to see what wants to read about, otherwise it should automatically default to React.
Just trying to keep it consistent, and I'll leave it to you to proceed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR corresponds with one in frontpage that completely removes the renderer from the URL. URLs containing a renderer will redirect to the the correct renderer-less URL with zero affect on whatever renderer is in their localStorage and used for the site.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additionally, I opted to not remove the renderer from the various URLs in READMEs in this PR. While most renderers only have a few results, react
has 150+ and I didn't want to make this one any bigger than it needed to be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @kylegach, for putting this pull request together and significantly improving the documentation. I've checked a few small items for you to consider when you have a moment. To unblock you, I'm approving the pull request.
48fe4e3
to
fc933ba
Compare
- Remove emoji from top-level titles - Remove `bullet-link` type
- Rename `introduction.md`, `overview.md`, `how-to-contribute.md` pages -> `index.md` pages - Add all-new `index.md` pages for Sharing and API - Find/replace `introduction.md`/`overview.md` -> `index.md` - Find/replace `/introduction`/`/overview` -> `/` - Add `hideRendererSelector: true` to frontmatter of (some) pages that aren't conditional on renderer
- Re-arrange install, to be less intimidating - Fix What's a story? title - Remove H4s from Why Storybook? - Fix typo
fc933ba
to
8409ac7
Compare
What I did
See also: storybookjs/frontpage#626
bullet-link
/<renderer>
from URLs in the CLI templates/<renderer>
from URLs in the docsheading
typeintroduction.md
,overview.md
,how-to-contribute.md
pages ->index.md
pagesindex.md
pages for Sharing and APIredirectPath
toget-started
TOC itemintroduction.md
/overview.md
->index.md
/introduction
//overview
->/
hideRendererSelector: true
to frontmatter of (some) pages that aren't conditional on rendererChecklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>