feat(Breadcrumb): Update behavior guidelines
What does this MR do?
With updates to the navigation, the breadcrumb documentation has fallen behind as the source of truth. This change aims to bring guidance back in line with the expectations while also defining the behavior and content necessary to support the constraints in which the breadcrumb appears.
Related #1562 (closed)
Unblocks gitlab-org/gitlab#358113 (closed)
Illustrative example
These mockups are not a perfect example, but they are meant to show the constraints the breadcrumb is forced into.
Before | After |
---|---|
Does this MR meet the acceptance criteria?
-
The MR title and commit messages meet the Pajamas commit conventions. -
The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”. - For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
-
Relevant label(s) are applied to the MR. -
The MR is added to a milestone. -
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
Edited by Jeremy Elder