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: Remove transcludeMarkdown from addon-docs readme #24561

Merged
merged 2 commits into from
Oct 26, 2023

Conversation

jonniebigodes
Copy link
Contributor

Closes #24444

What I did

With this pull request, the transcludeMarkdown was removed from the Addon Docs Readme as of Storybook 7.0 the option was removed, and we've added the option via the Doc Blocks API, specifically the Markdown Block.

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 self-assigned this Oct 23, 2023
@JReinhold JReinhold added the ci:docs Run the CI jobs for documentation checks only. label Oct 26, 2023
@JReinhold JReinhold changed the title Docs: Addon-docs minor changes Docs: Remove transcludeMarkdown from addon-docs readme Oct 26, 2023
@JReinhold JReinhold merged commit 65ea5c5 into next Oct 26, 2023
10 checks passed
@JReinhold JReinhold deleted the docs_remove_transclude_option branch October 26, 2023 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Unable to render .md files in mdx using addon-docs transcludeMarkdown: true option
2 participants