Skip to content

Docs: Updates documentation and examples for Highlight#23830

Merged
jonniebigodes merged 5 commits into
nextfrom
chore_docs_update_highlight
Aug 22, 2023
Merged

Docs: Updates documentation and examples for Highlight#23830
jonniebigodes merged 5 commits into
nextfrom
chore_docs_update_highlight

Conversation

@jonniebigodes
Copy link
Copy Markdown
Contributor

Closes #23487

What I did

With this pull request the official documentation for the Highlight addon and the corresponding package Readme were updated to the current state of Storybook.

What was done:

  • Updated examples in the official documentation
  • Updated the images for both the readme and docs
  • Updated the Readme

@yannbf I left the ci:docs label as this is technically a documentation update, and unsure if there are any others required for this case. Let me know and we'll go from there

How to test

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]

🦋 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 addon: highlight ci:docs Run the CI jobs for documentation checks only. labels Aug 14, 2023
@jonniebigodes jonniebigodes requested a review from yannbf as a code owner August 14, 2023 14:02
@jonniebigodes jonniebigodes self-assigned this Aug 14, 2023
Comment thread code/addons/highlight/README.md Outdated
Comment thread code/addons/highlight/README.md
Comment thread code/addons/highlight/README.md
Comment thread code/addons/highlight/README.md Outdated
Comment thread code/addons/highlight/README.md Outdated
Comment thread code/addons/highlight/README.md
Comment thread code/addons/highlight/README.md
Comment thread docs/snippets/vue/addon-highlight-reset.js.mdx
Comment thread code/addons/highlight/README.md Outdated
Comment thread docs/snippets/vue/component-story-highlight-addon.js.mdx
Copy link
Copy Markdown
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

This looks fantastic 👏 thanks a lot!

@jonniebigodes jonniebigodes merged commit 1875291 into next Aug 22, 2023
@jonniebigodes jonniebigodes deleted the chore_docs_update_highlight branch August 22, 2023 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addon: highlight 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]: Essential addons - Highlight addon missing page

3 participants