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: MDX minor fixes #26781

Merged
merged 2 commits into from
Apr 9, 2024
Merged

Docs: MDX minor fixes #26781

merged 2 commits into from
Apr 9, 2024

Conversation

jonniebigodes
Copy link
Contributor

Follows up on #25675

What I did

With this small pull request the MDX documentation and FAQ were updated to factor in:

  • Broken links in the documentation
  • Minor grammar issues

What was done:

  • Removed unused snippets
  • Updated MDX docs to avoid broken links
  • Updated the FAQ for grammar and some incorrect mentions.

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 patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Apr 9, 2024
@jonniebigodes jonniebigodes self-assigned this Apr 9, 2024
Copy link

nx-cloud bot commented Apr 9, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b2147af. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes merged commit cd5d79e into next Apr 9, 2024
17 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_MDX branch April 9, 2024 14:19
storybook-bot pushed a commit that referenced this pull request Apr 9, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 9, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 9, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 11, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
storybook-bot pushed a commit that referenced this pull request Apr 11, 2024
Docs: MDX minor fixes
(cherry picked from commit cd5d79e)
@github-actions github-actions bot mentioned this pull request Apr 11, 2024
12 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 11, 2024
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 patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant