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: Fix FAQ #26326

Merged
merged 3 commits into from
Mar 5, 2024
Merged

Docs: Fix FAQ #26326

merged 3 commits into from
Mar 5, 2024

Conversation

jonniebigodes
Copy link
Contributor

Closes #25847

What I did

With this pull request, the documentation, specifically the FAQ was updated to remove the last items relevant to removals and deprecations

What was done:

  • Polished the FAQ with:
    • Removing the inbuilt table of contents as it was duplicating the documentation and expanding what is already a large page as seen below
      toc-duplicate
    • Addressed the removal
    • Clean up on the community addons

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>

@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Mar 5, 2024
@jonniebigodes jonniebigodes self-assigned this Mar 5, 2024
@jonniebigodes jonniebigodes merged commit 69f0248 into next Mar 5, 2024
16 checks passed
@jonniebigodes jonniebigodes deleted the docs_faq_tweaks branch March 5, 2024 17:57
@github-actions github-actions bot mentioned this pull request Mar 6, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: Audit SB8 removals in the API docs
1 participant