Add Breadcrumb docs #583
Open
Add Breadcrumb docs #583
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Summary <!-- A few sentences describing the changes being proposed in this pull request. --> ## List of notable changes: <!-- E.g. - **added** # for # component because # - **removed** props for # component because # - **updated** documentation for # component because # --> - - ## What should reviewers focus on? <!-- Help reviewers check the changes applied. E.g. For site designers Verify that the implementation is aligned with the design proposal: - Ensure the layout and the spacing are correct in different viewport sizes (desktop, tablet and mobile). - Check dark and light color modes. - Check the interactive states, such as hover, focus or active ones. --> - - ## Steps to test: <!-- Help reviewers test the feature by providing steps to reproduce the behavior. E.g. 1. Open the # component in CI-deployed preview environment 2. Go to # story in Storybook 3. Verify that # behaves as described in the following issue. --> 1. 1. 1. ## Supporting resources (related issues, external links, etc): - - ## Contributor checklist: - [ ] All new and existing CI checks pass - [ ] Tests prove that the feature works and covers both happy and unhappy paths - [ ] Any drop in coverage, breaking changes or regressions have been documented above - [ ] New visual snapshots have been generated / updated for any UI changes - [ ] All developer debugging and non-functional logging has been removed - [ ] Related issues have been referenced in the PR description ## Reviewer checklist: - [ ] Check that pull request and proposed changes adhere to our [contribution guidelines](../../CONTRIBUTING.md) and [code of conduct](../../CODE_OF_CONDUCT.md) - [ ] Check that tests prove the feature works and covers both happy and unhappy paths - [ ] Check that there aren't other open Pull Requests for the same update/change ## Screenshots: > Please try to provide before and after screenshots or videos <table> <tr> <th> Before</th> <th> After </th> </tr> <tr> <td valign="top"> <!-- Insert "before" screenshot here --> </td> <td valign="top"> <!-- Insert "after" screenshot here --> </td> </tr> </table>
|
🟢 No design token changes found |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a first version of the breadcrumb docs. A lot of the content is from the primer.style entry for Product UI breadcrumbs. This opens up an opportunity for an ADR on how to handle shared component documentation.
What should reviewers focus on?
For site designers
For Primer maintainers
Supporting resources (related issues, external links, etc):
Contributor checklist:
Reviewer checklist:
Screenshots: