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: Add Parameters API reference #25489

Merged
merged 2 commits into from
Jan 8, 2024
Merged

Docs: Add Parameters API reference #25489

merged 2 commits into from
Jan 8, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Jan 6, 2024

Contributes to (but does not close): #17243

What I did

  • Add a Parameters API reference
  • There are very few parameters for Storybook itself, so most of the work is adding API sections to the essential addons docs

See also: storybookjs/addon-kit#61

Checklist for Contributors

Testing

Manual testing

  1. Follow the steps in the contributing instructions for this branch, api-ref-parameters

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>

@kylegach kylegach 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 Jan 6, 2024
@kylegach kylegach self-assigned this Jan 6, 2024
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Great work @kylegach !! A few minor points

}
```

#### `options.storySort`
Copy link
Member

Choose a reason for hiding this comment

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

Note: This is only valid in project annotations. It probably should not be a parameter, but we haven't changed it yet


<div class="aside">

ℹ️ Parameters are **merged**, so individual keys are always overwritten, never dropped.
Copy link
Member

Choose a reason for hiding this comment

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

Probably worth clarifying the merge semantics in detail here. Objects are deep-merged, but arrays are replaced.

So merging

{
  a: 'a1',
  nested: { b: 'b1' },
  array: [1, 2]
}

With

{
  a: 'a2',
  nested: { c: 'c2' },
  array: [3, 4]
}

would yield

{
  a: 'a2',
  nested: { b: 'b1', c: 'c2' },
  array: [3, 4]
}

@kylegach kylegach changed the title Add Parameters API reference Docs: Add Parameters API reference Jan 8, 2024
- Add API references for all essential addons
- Consolidate related snippets
- Clarify that `options` can only be applied at project level
- Make parameters merge semantics more clear
@kylegach kylegach force-pushed the api-ref-parameters branch from 86d49fc to c4d3fc5 Compare January 8, 2024 19:59
@kylegach kylegach removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 8, 2024
@kylegach kylegach merged commit b023d3f into next Jan 8, 2024
24 checks passed
@kylegach kylegach deleted the api-ref-parameters branch January 8, 2024 21:14
@github-actions github-actions bot mentioned this pull request Jan 8, 2024
21 tasks
@github-actions github-actions bot mentioned this pull request Jan 10, 2024
25 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.

2 participants