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

Docs: Changes corresponding with docs design updates #24830

Closed
wants to merge 9 commits into from

Conversation

cdedreuille
Copy link
Contributor

@cdedreuille cdedreuille commented Nov 13, 2023

What I did

See also: storybookjs/frontpage#626

  • Top-level headings instead of menus
  • Remove emoji from and simplify top-level titles
  • Remove most first pages (Introduction, Overview) - Rename those files (introduction.md, overview.md) to index.md (and find/replace URLs in content)
  • Remove concept of bullet-link
  • Remove /<renderer> from all URLs

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>

- Top-level `heading`s instead of `menu`s
- Remove emoji from and simplify top-level titles
- Remove most first pages (Introduction, Overview)
    - Rename those files (introduction.md, overview.md) to `index.md` (and find/replace URLs in content)
    - TODO: Get started, Sharing, API still need `index.md` files
- Remove concept of `bullet-link`
@cdedreuille cdedreuille added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 13, 2023
@cdedreuille cdedreuille changed the title WIP: Structural TOC changes Docs: Structural TOC changes Nov 13, 2023
@cdedreuille cdedreuille marked this pull request as ready for review November 13, 2023 19:27
@cdedreuille cdedreuille marked this pull request as draft November 13, 2023 19:28
@kylegach kylegach added ci:normal and removed ci:docs Run the CI jobs for documentation checks only. labels Nov 20, 2023
@kylegach kylegach changed the title Docs: Structural TOC changes Docs: Changes corresponding with docs design updates Nov 20, 2023
@kylegach
Copy link
Contributor

Closing in favor of a more minimal approach in #24925

@kylegach kylegach closed this Nov 20, 2023
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