Skip to content

Conversation

@jonniebigodes
Copy link
Contributor

What I did

With this pull request the documentation for the Canvas Doc Block was updated to factor in some minor changes related to wording and also fixing links to non-existing sections.

@kylegach, when you have a moment, can you check this and take it from here so that the documentation is published and made available to users? Thanks in advance.

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 Jan 9, 2024
Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

👍

@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 9, 2024
@kylegach kylegach merged commit ab3bd2a into next Jan 9, 2024
@kylegach kylegach deleted the docs_api_doc_block_fix_broken_link branch January 9, 2024 15:31
@github-actions github-actions bot mentioned this pull request Jan 9, 2024
21 tasks
storybook-bot pushed a commit that referenced this pull request Jan 9, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
@github-actions github-actions bot mentioned this pull request Jan 9, 2024
6 tasks
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
@github-actions github-actions bot mentioned this pull request Jan 10, 2024
25 tasks
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
…ken_link

Docs: Doc Block Canvas fix link
(cherry picked from commit ab3bd2a)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jan 12, 2024
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants