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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Changes corresponding to docs design updates #24925

Merged
merged 5 commits into from Nov 28, 2023

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Nov 20, 2023

What I did

See also: storybookjs/frontpage#626

  • Remove emoji from and simplify top-level titles
  • Remove concept of bullet-link
  • Remove /<renderer> from URLs in the CLI templates
  • Remove /<renderer> from URLs in the docs
  • Update TOC to use heading type
    • Rename introduction.md, overview.md, how-to-contribute.md pages -> index.md pages
    • Add all-new index.md pages for Sharing and API
    • Add redirectPath to get-started TOC item
      • Temporary workaround until we build a proper docs homepage
    • 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

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

@kylegach kylegach added maintenance User-facing maintenance tasks ci:normal labels Nov 20, 2023
@kylegach kylegach self-assigned this Nov 20, 2023
@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 20, 2023
@kylegach kylegach force-pushed the changes-from-docs-updates branch 3 times, most recently from a9f1a80 to 049bed3 Compare November 22, 2023 00:25
@@ -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:
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

@kylegach kylegach Nov 27, 2023

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.

Copy link
Contributor

@jonniebigodes jonniebigodes left a 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.

@kylegach kylegach removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Nov 27, 2023
- 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
@JReinhold JReinhold merged commit c4d5f05 into next Nov 28, 2023
60 checks passed
@JReinhold JReinhold deleted the changes-from-docs-updates branch November 28, 2023 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants