doc: Add Brands section to documentation#3552
Conversation
✅ Deploy Preview for boosted ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Made a first version that is ok I think to be deployed, based on Cyriaque's texts modifications and Jerome's designs (ask LM for Figma URL). Could maybe be improved :-) |
|
@louismaximepiton @MaxLardenois The sosh logo should be changed now that we updated the tokens to the new Sosh colors... And I still wonder if we should have the copy button for the logos, since the copied code is not minimized...? |
There was a problem hiding this comment.
Pull request overview
This PR introduces a new “Themes and brands” documentation page to describe OUDS Web’s three themes (Orange, Orange Compact, Sosh), updates navigation to surface it under Foundation, and adds new shortcodes/assets to demo each theme and display the corresponding SVG logos.
Changes:
- Added a new Foundation doc page (
foundation/themes) and aliased the previous/docs/about/brand/route to it (removing the placeholder Brand page). - Added
ThemeDemo+ThemeDemoStylesImportshortcodes and registered them for auto-import. - Updated/added SVG logo assets (minified + formatted) for docs and packages.
Reviewed changes
Copilot reviewed 6 out of 16 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| site/static/[brand]/docs/[version]/assets/brand/sosh-logo.svg | Minified Sosh logo SVG used in docs. |
| site/static/[brand]/docs/[version]/assets/brand/sosh-logo-formatted.svg | Added formatted Sosh logo SVG for code display/copy. |
| site/static/[brand]/docs/[version]/assets/brand/orange-logo.svg | Updated Orange logo SVG (responsive behavior via SVG/CSS). |
| site/static/[brand]/docs/[version]/assets/brand/orange-logo-formatted.svg | Added formatted Orange logo SVG for code display/copy. |
| site/static/[brand]/docs/[version]/assets/brand/orange-compact-logo.svg | Updated Orange Compact logo SVG asset. |
| site/static/[brand]/docs/[version]/assets/brand/orange-compact-logo-formatted.svg | Added formatted Orange Compact logo SVG for code display/copy. |
| site/src/types/auto-import.d.ts | Registered new shortcodes (ThemeDemo, ThemeDemoStylesImport) for global auto-import typing. |
| site/src/content/docs/foundation/themes.mdx | New “Themes and brands” page with theme demo sections and logo examples. |
| site/src/content/docs/about/brand.mdx | Removed placeholder “brand” page content (route now aliased to themes page). |
| site/src/components/shortcodes/ThemeDemoStylesImport.astro | New shortcode to load/scoped theme styles for the demo blocks. |
| site/src/components/shortcodes/ThemeDemo.astro | New shortcode rendering a component showcase per theme. |
| site/src/components/shortcodes/SvgDocs.astro | Updated SVG docs shortcode to support theme-based default logo selection. |
| site/data/sidebar-foundation.yml | Added “Themes” entry to Foundation sidebar. |
| packages/sosh/sosh-logo.svg | Reformatted Sosh package logo SVG. |
| packages/orange/orange-logo.svg | Updated Orange package logo SVG. |
| packages/orange-compact/orange-compact-logo.svg | Updated Orange Compact package logo SVG. |
| data-bs-toggle="dropdown" | ||
| data-bs-display="static" | ||
| aria-label={`Toggle brand (${getConfig().brand})`} | ||
| aria-label={`Toggle theme (${getConfig().brand})`} |
There was a problem hiding this comment.
I agree with this vocabulary change but I think we should do it everywhere (code included). To discuss in a v2? added in the Loop file
| <div data-bs-brand={theme} id={`theme-demo-${theme}`} class="p-medium border border-default"> | ||
| <div class="row mb-scaled-medium"> | ||
| <div class="col-12"> | ||
| <div class="alert alert-message alert-positive mb-medium"> |
There was a problem hiding this comment.
Couldn't we reuse component-details.ts snippets? I fear we will forget to update this file when adding/updating components...
|
|
||
| --- | ||
|
|
||
| <style is:global lang="scss"> |
There was a problem hiding this comment.
Wondering if web components would not help here... but we would need to use compiled CSS. Just a thought, not to implement right now
|
|
||
| import { getVersionedDocsPath } from '@libs/path' | ||
|
|
||
| The OUDS Web design system offers three distinct themes: Orange, Orange Compact, and Sosh, representing two brands—Orange and Sosh. Each theme is applied consistently across all elements of the design system, featuring its own color scheme, typography, grid, logo, and more. These themes are intended for use in different contexts and for various purposes, and they should not be mixed within the same project. Each project must select one theme and apply it uniformly across all screens. |
There was a problem hiding this comment.
| The OUDS Web design system offers three distinct themes: Orange, Orange Compact, and Sosh, representing two brands—Orange and Sosh. Each theme is applied consistently across all elements of the design system, featuring its own color scheme, typography, grid, logo, and more. These themes are intended for use in different contexts and for various purposes, and they should not be mixed within the same project. Each project must select one theme and apply it uniformly across all screens. | |
| OUDS Web offers three distinct themes: Orange, Orange Compact, and Sosh, representing two brands—Orange and Sosh. Each theme is applied consistently across all elements of the design system, featuring its own color scheme, typography, grid, logo, and more. These themes are intended for use in different contexts and for various purposes, and they should not be mixed within the same project. Each project must select one theme and apply it uniformly across all screens. |
|
|
||
| The OUDS Web design system offers three distinct themes: Orange, Orange Compact, and Sosh, representing two brands—Orange and Sosh. Each theme is applied consistently across all elements of the design system, featuring its own color scheme, typography, grid, logo, and more. These themes are intended for use in different contexts and for various purposes, and they should not be mixed within the same project. Each project must select one theme and apply it uniformly across all screens. | ||
|
|
||
| This page introduces the three OUDS Web themes. Throughout the rest of the documentation, you can switch themes using the menu in the header. |
There was a problem hiding this comment.
| This page introduces the three OUDS Web themes. Throughout the rest of the documentation, you can switch themes using the menu in the header. | |
| This page showcases the three OUDS Web themes. Throughout the rest of the documentation, you can switch themes using the menu in the header. |
Wondering if we should put the Theme picker icon between theand menu in this sentence?
|
|
||
| This page introduces the three OUDS Web themes. Throughout the rest of the documentation, you can switch themes using the menu in the header. | ||
|
|
||
| <Callout type="negative" title="Using multiple themes in the same project"> |
There was a problem hiding this comment.
| <Callout type="negative" title="Using multiple themes in the same project"> | |
| <Callout type="negative" title="Do not use multiple themes in the same project"> |
| This page introduces the three OUDS Web themes. Throughout the rest of the documentation, you can switch themes using the menu in the header. | ||
|
|
||
| <Callout type="negative" title="Using multiple themes in the same project"> | ||
| OUDS Web is designed for use with a single theme per project. However, this page demonstrates multiple themes as a demo. This practice should not be replicated in actual projects, as it can create confusion and inconsistency in design. |
There was a problem hiding this comment.
| OUDS Web is designed for use with a single theme per project. However, this page demonstrates multiple themes as a demo. This practice should not be replicated in actual projects, as it can create confusion and inconsistency in design. | |
| OUDS Web is designed for use with a single theme per project. This page serves as a themes showcase and should not be replicated in actual projects, as it can create confusion and inconsistency in design. |
|
|
||
| ### Logo for Orange theme | ||
|
|
||
| OUDS Web provides a single SVG file for both master and small Orange logos, since it’s lightweight and easily made responsive. Here is the unminified SVG content: |
There was a problem hiding this comment.
| OUDS Web provides a single SVG file for both master and small Orange logos, since it’s lightweight and easily made responsive. Here is the unminified SVG content: | |
| OUDS Web provides a single SVG file for both main and small Orange logos, since it’s lightweight and easily made responsive. Here is the unminified SVG content: |
|
|
||
| ### Logo for Orange compact theme | ||
|
|
||
| OUDS Web provides a single SVG file for both master and small Orange logos, since it’s lightweight and easily made responsive. It is the same logos as the ones used in the Orange theme. Here is the unminified SVG content: |
There was a problem hiding this comment.
| OUDS Web provides a single SVG file for both master and small Orange logos, since it’s lightweight and easily made responsive. It is the same logos as the ones used in the Orange theme. Here is the unminified SVG content: | |
| OUDS Web provides a single SVG file for both main and small Orange logos, since it’s lightweight and easily made responsive. It is the same logos as the ones used in the Orange theme. Here is the unminified SVG content: |
Related issues
Closes #3531
Description
Checklists
Progression (for Core Team only)
ouds/mainfollowing conventional commitLive previews