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.

Sign up for GitHub

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

Jump to bottom

API docs for additional components #2135

Merged
merged 46 commits into from
May 28, 2024
Merged

API docs for additional components #2135

merged 46 commits into from
May 28, 2024

Conversation

jattasNI
Copy link
Contributor

@jattasNI jattasNI commented May 22, 2024 •
edited
Loading

Pull Request

🤨 Rationale

Ongoing efforts towards #824. This PR builds on #2132 and covers these components:

  • tree
  • toolbar
  • icon
  • dialog
  • drawer
  • spinner
  • breadcrumb
  • theme provider

👩‍💻 Implementation

Mostly following established patterns. Interesting bits:

  • moved a nimble-components/src/dialog/tests/types.ts to the storybook package since it iss only used by storybook
  • collapsed 2 controls into 1 in the dialog story
  • added a new table section called Styles for controls that impact CSS
  • removed "allowNavigation" capability from breadcrumb story because it was just showing native event behavior (i.e. how to cancel an event) and didn't have any documentation
  • moved "Target Configuration" section under the relevant component API section for several components.

🧪 Testing

Storybook inspection

✅ Checklist

  • I have updated the project documentation to reflect my changes or determined no changes are needed.

@jattasNI jattasNI mentioned this pull request May 24, 2024
Open
16 tasks
Base automatically changed from api-docs-inputs to main May 24, 2024 20:48
@jattasNI jattasNI marked this pull request as ready for review May 24, 2024 21:36
@jattasNI jattasNI requested a review from rajsite as a code owner May 24, 2024 21:36
@jattasNI jattasNI requested a review from m-akinc May 24, 2024 21:36
@jattasNI
Copy link
Contributor Author

jattasNI commented May 24, 2024 •
edited
Loading

@m-akinc can you buddy this next round? I tried to apply the best practices you suggested in the last PR for new docs here, but didn't address any of the storybook-wide suggestions tracked by #824 yet.

m-akinc
m-akinc approved these changes May 24, 2024
View reviewed changes
packages/storybook/src/utilities/storybook.ts Outdated Show resolved Hide resolved
packages/storybook/src/nimble/banner/banner.mdx Outdated Show resolved Hide resolved
packages/storybook/src/nimble/breadcrumb/breadcrumb.mdx Show resolved Hide resolved
packages/storybook/src/nimble/breadcrumb/breadcrumb.mdx Outdated Show resolved Hide resolved
packages/storybook/src/nimble/breadcrumb/breadcrumb.stories.ts Outdated Show resolved Hide resolved
packages/storybook/src/nimble/tree-view/tree-view.stories.ts Outdated Show resolved Hide resolved
packages/storybook/src/nimble/tree-view/tree-view.stories.ts Show resolved Hide resolved
packages/storybook/src/nimble/tree-view/tree-view.stories.ts Outdated Show resolved Hide resolved
packages/storybook/src/nimble/tree-view/tree-view.stories.ts Outdated Show resolved Hide resolved
packages/storybook/src/nimble/tree-view/tree-view.stories.ts Outdated Show resolved Hide resolved
@jattasNI jattasNI requested a review from fredvisser as a code owner May 28, 2024 22:12
@jattasNI
Copy link
Contributor Author

Bypassing reviewer policy due to OOO

@jattasNI jattasNI merged commit 4557120 into main May 28, 2024
13 checks passed
@jattasNI jattasNI deleted the api-docs-again branch May 28, 2024 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-akinc m-akinc m-akinc approved these changes

@rajsite rajsite Awaiting requested review from rajsite rajsite is a code owner

@fredvisser fredvisser Awaiting requested review from fredvisser fredvisser is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jattasNI @m-akinc