Skip to content

feat(CollectionPages): Add collections

Jeremy Elder requested to merge jeldergl-overview-pages into main

Purpose

Add collection pages for high-level categories, similar to what already exists for components. The audience is primarily the design system team.

These pages are intentionally not revealed in the navigation and only serve as a "collection" of the content pages within a certain section. This enables us to have links from the homepage, and elsewhere that can reference a set of content without needing to provide an overview page. For example, see this draft MR (!4012) that has lead-ins linking to a page like these. On the note of "overview," this concept is still used and exposed in the navigation when it's helpful for decision making or to provide higher-level context, whereas collection pages are only a group of related links with descriptions.

Specifically this MR:

  • A larger number of small, related changes to keep context.

  • Creates several "collection" pages for content categories:

    • /co‎mponents
    • /content
    • /data-visualization
    • /objects
    • /patterns
    • /product-foundations
    • /usability
  • Removes the component overview page from the navigation and changes it to a collection (links to this page have been updated too). Also removed use of h3 in the list since h2 is skipped, and these aren't helpful as sections demarcated by headings.

    Before After
    Screenshot 2024-09-23 at 14.21.23.png Screenshot 2024-09-23 at 14.21.38.png
  • Adds descriptions for pages that don't have them. Note that no page within the Foundations or Objects section has a description, so to reduce this MR at least a little bit, descriptions have not been added there.

  • Removes one page (Internationalization) that's been empty for some time with no current plans for completion.

  • Updates the /get-started/navigating-pajamas page to list content in the same order as the nav, only include product sections of the design system, match content with the collection pages, and link to the collection pages (and overview page for data visualization).

Example collection page with descriptions

CleanShot_2024-09-18_at_15.14.01_2x

The best way to access all of the collection pages is from the updated /get-started/navigating-pajamas page.

Edited by Dan MH

Merge request reports