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: Updating withVuetifyDecorator example #26670

Closed
wants to merge 69 commits into from

Conversation

justingish
Copy link
Contributor

What I did

The Vuetify decorator example was expecting that the labels from the theme switcher would exactly match the vuetify theme keys from the vuetifyOptions. This change makes that association more explicit while also allowing the display labels to be different from the Vuetify theme keys.

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!

No manual testing is necessary. This is simply a docs update.

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>

JReinhold and others added 30 commits March 11, 2024 16:14
Co-authored-by: Jeppe Reinhold <jeppe@chromatic.com>
…velte-webpack5

Docs: Add `svelte-webpack5` framework doc
…ue3-webpack5

Docs: Add `vue3-webpack5` framework doc
…eb-components-vite

Docs: Add `web-components-vite` framework doc
…eb-components-webpack5

Docs: Add `web-components-webpack5` framework doc
Co-authored-by: Jeppe Reinhold <jeppe@chromatic.com>
- Mark features as experimental
- Update types
…veltekit

Docs: Add `sveltekit` framework doc
- Same changes as in storybookjs#26401, targeting `main`
…67-build-out-docs-homepage-latest

Docs: Add get started index (latest)
…-2-latest

Docs: Fix get started 2 (latest)
…fix-headings

Docs: Fix heading levels of `useOf` API reference
(cherry picked from commit 85adf5a)
shilman and others added 19 commits March 19, 2024 23:07
…recated-icons

UI: Replace the icon prop in the Manager API
(cherry picked from commit e13d0b7)
…pty-component-title

Bug: Remove redundant component check, as we auto-generate titles from the file system
(cherry picked from commit b389754)
…tion-next-in-cli

CLI: Instruct the correct auto-migration command
(cherry picked from commit 1726622)
…lations-command

CLI: Throw an error when running upgrade command in incorrect cwd
(cherry picked from commit 7b9e094)
…d-ref-docgen-usecase

Addon Docs: Support Stencil based display names in source snippets

(cherry picked from commit d7db290)
…-component-meta

Vue: Support `defineModel` and slots without bindings for vue-component-meta docgen plugin
The Vuetify decorator example was expecting that the labels from the theme switcher would exactly match the vuetify theme keys from the vuetifyOptions.  This change makes that association more explicit while also allowing the display labels to be different from the Vuetify theme keys.
@valentinpalkovic valentinpalkovic changed the title Updating withVuetifyDecorator example Docs: Updating withVuetifyDecorator example Apr 5, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@justingish, first and foremost, sorry for the radio silence on this pull request. I've been tasked with other documentation changes that required my attention, which is why I couldn't verify this. With that out of the way, thank you for taking the time to put this small but significant change into the documentation. We appreciate it 🙏 ! I left one small item for you to look into when you can.

Let me know and we'll take it from there.

Have a great day.

Stay safe

code/addons/themes/docs/api.md Outdated Show resolved Hide resolved
@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 17, 2024
Copy link

nx-cloud bot commented Apr 17, 2024

☁️ Nx Cloud Report

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

@yannbf yannbf changed the base branch from main to next April 19, 2024 07:16
@yannbf
Copy link
Member

yannbf commented Apr 19, 2024

Hey @justingish as this PR was made based on the main branch, I'll have to close it (PRs should be done from the next branch so we can patch them back to main). But worry not, I made another PR with your contribution in it here: #26883

Thank you so much for your contribution!!

@yannbf yannbf closed this Apr 19, 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: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.

None yet