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 links and assorted fixes #28496

Merged
merged 2 commits into from
Jul 9, 2024
Merged

Docs: Fix links and assorted fixes #28496

merged 2 commits into from
Jul 9, 2024

Conversation

jonniebigodes
Copy link
Contributor

Closes #

What I did

With this pull request the documentation was updated to address some broken links and some other minor issues that arose with the recent documentation maintenance work.

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 Jul 9, 2024
@jonniebigodes jonniebigodes self-assigned this Jul 9, 2024
Copy link

nx-cloud bot commented Jul 9, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 3e765ab. 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.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

  • Updated links in /MAINTAINERS.md to point to .mdx files
  • Fixed broken links in multiple documentation files (e.g., docs/addons/integration-catalog.mdx, docs/api/arg-types.mdx)
  • Corrected typos and formatting issues in examples (e.g., docs/addons/addons-api.mdx, docs/configure/user-interface/features-and-behavior.mdx)
  • Improved table formatting for better readability (e.g., docs/api/csf.mdx, docs/essentials/controls.mdx)
  • Added blank lines for readability within Callout components (e.g., docs/api/doc-blocks/doc-block-meta.mdx, docs/contribute/code.mdx)

29 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@jonniebigodes jonniebigodes merged commit 687560f into next Jul 9, 2024
11 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_links branch July 9, 2024 23:04
@github-actions github-actions bot mentioned this pull request Jul 10, 2024
3 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.

1 participant