From d828dd3600ed99efc7ba6b260aa04fbf273d9bde Mon Sep 17 00:00:00 2001 From: Lea Verou Date: Wed, 26 Mar 2025 15:22:48 -0400 Subject: [PATCH] Use overviews in pattern subcategories (#826) * Do not error if no pages * Automatically set parents and tags for patterns * Update overview.njk * [WIP] Use overview pages for pattern listings * Remove explicit parents --------- Co-authored-by: lindsaym-fa --- docs/docs/patterns/app/action-panel.md | 4 +-- docs/docs/patterns/app/app.json | 3 ++ docs/docs/patterns/app/comments.md | 6 ++-- docs/docs/patterns/app/data-display.md | 4 +-- docs/docs/patterns/app/description-list.md | 4 +-- docs/docs/patterns/app/empty-state.md | 4 +-- docs/docs/patterns/app/faq.md | 4 +-- docs/docs/patterns/app/feed.md | 4 +-- docs/docs/patterns/app/grid.md | 4 +-- docs/docs/patterns/app/index.njk | 26 ++--------------- docs/docs/patterns/app/leaderboard.md | 4 +-- docs/docs/patterns/app/pagination.md | 4 +-- docs/docs/patterns/app/pricing.md | 18 ++++++------ .../patterns/ecommerce/category-filter.md | 6 ++-- .../patterns/ecommerce/category-preview.md | 16 +++++------ docs/docs/patterns/ecommerce/checkout-form.md | 4 +-- docs/docs/patterns/ecommerce/ecommerce.json | 3 ++ docs/docs/patterns/ecommerce/incentives.md | 6 ++-- docs/docs/patterns/ecommerce/index.njk | 28 +++---------------- docs/docs/patterns/ecommerce/order-history.md | 6 ++-- docs/docs/patterns/ecommerce/order-summary.md | 12 ++++---- docs/docs/patterns/ecommerce/product-list.md | 24 ++++++++-------- .../patterns/ecommerce/product-overview.md | 6 ++-- .../patterns/ecommerce/product-preview.md | 10 +++---- docs/docs/patterns/ecommerce/review.md | 10 +++---- docs/docs/patterns/ecommerce/shopping-cart.md | 20 ++++++------- .../patterns/ecommerce/store-navigation.md | 3 +- docs/docs/patterns/information/index.njk | 26 +++-------------- .../patterns/information/information.json | 3 ++ docs/docs/patterns/information/newsletter.md | 5 ++-- docs/docs/patterns/information/paywall.md | 4 +-- .../docs/patterns/information/social-share.md | 2 -- 32 files changed, 92 insertions(+), 191 deletions(-) create mode 100644 docs/docs/patterns/app/app.json create mode 100644 docs/docs/patterns/ecommerce/ecommerce.json create mode 100644 docs/docs/patterns/information/information.json diff --git a/docs/docs/patterns/app/action-panel.md b/docs/docs/patterns/app/action-panel.md index 6a0812b41..cb7669cff 100644 --- a/docs/docs/patterns/app/action-panel.md +++ b/docs/docs/patterns/app/action-panel.md @@ -1,8 +1,6 @@ --- title: Action Panel description: 'These patterns help add user actions to dashboards' -parent: app -tags: app icon: action-panel --- ## Examples @@ -41,4 +39,4 @@ icon: action-panel -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/app.json b/docs/docs/patterns/app/app.json new file mode 100644 index 000000000..ec69525f8 --- /dev/null +++ b/docs/docs/patterns/app/app.json @@ -0,0 +1,3 @@ +{ + "tags": ["app"] +} diff --git a/docs/docs/patterns/app/comments.md b/docs/docs/patterns/app/comments.md index abc7ea673..2f0522859 100644 --- a/docs/docs/patterns/app/comments.md +++ b/docs/docs/patterns/app/comments.md @@ -1,8 +1,6 @@ --- title: Comments description: 'For feedback forms and message boxes' -parent: app -tags: app --- ## Examples @@ -34,7 +32,7 @@ tags: app - Comment + Comment @@ -72,4 +70,4 @@ tags: app Save -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/data-display.md b/docs/docs/patterns/app/data-display.md index b0cc3bf3c..6e722e0e2 100644 --- a/docs/docs/patterns/app/data-display.md +++ b/docs/docs/patterns/app/data-display.md @@ -1,8 +1,6 @@ --- title: Data Display description: TODO -parent: app -tags: app --- ## Examples @@ -157,4 +155,4 @@ tags: app -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/description-list.md b/docs/docs/patterns/app/description-list.md index 8736a671f..3593d4c16 100644 --- a/docs/docs/patterns/app/description-list.md +++ b/docs/docs/patterns/app/description-list.md @@ -1,8 +1,6 @@ --- title: Description List description: 'Shows the user information with labels and values in an easy to read format.' -parent: app -tags: app --- ## Examples @@ -241,4 +239,4 @@ tags: app -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/empty-state.md b/docs/docs/patterns/app/empty-state.md index 820d48c4e..61d757ce5 100644 --- a/docs/docs/patterns/app/empty-state.md +++ b/docs/docs/patterns/app/empty-state.md @@ -1,8 +1,6 @@ --- title: Empty State description: TODO -parent: app -tags: app --- ## Examples @@ -110,4 +108,4 @@ tags: app Or start from an empty project → -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/faq.md b/docs/docs/patterns/app/faq.md index b30fddc08..1d4b00c74 100644 --- a/docs/docs/patterns/app/faq.md +++ b/docs/docs/patterns/app/faq.md @@ -1,8 +1,6 @@ --- title: FAQ description: 'The user has questions concerning a site and its related services' -parent: app -tags: app --- ## Examples @@ -122,4 +120,4 @@ tags: app -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/feed.md b/docs/docs/patterns/app/feed.md index 3d9ada8d0..0383de8d3 100644 --- a/docs/docs/patterns/app/feed.md +++ b/docs/docs/patterns/app/feed.md @@ -1,8 +1,6 @@ --- title: Feed description: TODO -parent: app -tags: app --- ```html {.example} @@ -83,4 +81,4 @@ tags: app } } -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/grid.md b/docs/docs/patterns/app/grid.md index 0cc7aab2f..4f88761ac 100644 --- a/docs/docs/patterns/app/grid.md +++ b/docs/docs/patterns/app/grid.md @@ -1,8 +1,6 @@ --- title: Grid description: TODO -parent: app -tags: app --- ```html {.example} @@ -163,4 +161,4 @@ tags: app -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/index.njk b/docs/docs/patterns/app/index.njk index 9efa42648..1d8996549 100644 --- a/docs/docs/patterns/app/index.njk +++ b/docs/docs/patterns/app/index.njk @@ -1,28 +1,8 @@ --- title: App description: TODO -layout: page -categories: ["app"] +parent: patterns +layout: overview +override:tags: [] listChildren: true --- - -{% set appPages = collections.app %} - -
- {%- for page in appPages -%} - - - -
- {% include "svgs/" + (page.data.icon or "thumbnail-placeholder") + ".njk" %} -
- {{ page.data.title }} - {% if pageSubtitle -%} - - {%- endif %} -
-
- - {%- endfor -%} - -
diff --git a/docs/docs/patterns/app/leaderboard.md b/docs/docs/patterns/app/leaderboard.md index 944ab6c8f..61dd9982f 100644 --- a/docs/docs/patterns/app/leaderboard.md +++ b/docs/docs/patterns/app/leaderboard.md @@ -1,8 +1,6 @@ --- title: Leaderboard description: TODO -parent: app -tags: app --- ```html{.example} @@ -366,4 +364,4 @@ tags: app -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/pagination.md b/docs/docs/patterns/app/pagination.md index fa6291cbc..6b597457f 100644 --- a/docs/docs/patterns/app/pagination.md +++ b/docs/docs/patterns/app/pagination.md @@ -1,8 +1,6 @@ --- title: Pagination description: TODO -parent: app -tags: app --- ## Simple Pagination @@ -41,4 +39,4 @@ tags: app Next -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/app/pricing.md b/docs/docs/patterns/app/pricing.md index 995dd9127..7f34936fa 100644 --- a/docs/docs/patterns/app/pricing.md +++ b/docs/docs/patterns/app/pricing.md @@ -1,8 +1,6 @@ --- title: Pricing description: TODO -parent: app -tags: app --- ```html{.example} @@ -29,23 +27,23 @@ tags: app @@ -72,7 +70,7 @@ tags: app @@ -99,7 +97,7 @@ tags: app @@ -134,4 +132,4 @@ tags: app ### With templates -### With recommendations grid \ No newline at end of file +### With recommendations grid diff --git a/docs/docs/patterns/ecommerce/category-filter.md b/docs/docs/patterns/ecommerce/category-filter.md index 7df961f8f..081450020 100644 --- a/docs/docs/patterns/ecommerce/category-filter.md +++ b/docs/docs/patterns/ecommerce/category-filter.md @@ -1,8 +1,6 @@ --- title: Category Filter description: 'Helps the user find the right products with filters to refine search results by specific attributes.' -parent: ecommerce -tags: e-commerce icon: checkbox --- @@ -42,7 +40,7 @@ icon: checkbox XXL - + @@ -82,4 +80,4 @@ icon: checkbox -``` \ No newline at end of file +``` diff --git a/docs/docs/patterns/ecommerce/category-preview.md b/docs/docs/patterns/ecommerce/category-preview.md index 721789cdf..9efeb7cb5 100644 --- a/docs/docs/patterns/ecommerce/category-preview.md +++ b/docs/docs/patterns/ecommerce/category-preview.md @@ -1,8 +1,6 @@ --- title: Category Preview description: 'Help shoppers discover your product offerings with showcases of product categories.' -parent: ecommerce -tags: e-commerce icon: preview --- @@ -17,20 +15,20 @@ icon: preview
- -
- {% include "svgs/" + (page.data.icon or "thumbnail-placeholder") + ".njk" %} -
- {{ page.data.title }} - {% if pageSubtitle -%} - - {%- endif %} -
-
- - {%- endfor -%} - -
diff --git a/docs/docs/patterns/ecommerce/order-history.md b/docs/docs/patterns/ecommerce/order-history.md index a12e51e69..a889d9c66 100644 --- a/docs/docs/patterns/ecommerce/order-history.md +++ b/docs/docs/patterns/ecommerce/order-history.md @@ -1,8 +1,6 @@ --- title: Order History description: 'Empower your customers to view past purchases and track upcoming orders with comprehensive order histories.' -parent: ecommerce -tags: e-commerce --- ## List @@ -32,7 +30,7 @@ tags: e-commerce + diff --git a/docs/docs/patterns/ecommerce/order-summary.md b/docs/docs/patterns/ecommerce/order-summary.md index e2bd0721d..566e1ca31 100644 --- a/docs/docs/patterns/ecommerce/order-summary.md +++ b/docs/docs/patterns/ecommerce/order-summary.md @@ -1,8 +1,6 @@ --- title: Order Summary description: 'Give shoppers confidence in their purchases with summaries of everything included in their order.' -parent: ecommerce -tags: e-commerce --- ## Simple @@ -26,7 +24,7 @@ tags: e-commerce