feat(documentation): reorganize the whole documentation by louismaximepiton · Pull Request #3055 · Orange-OpenSource/Orange-Boosted-Bootstrap

louismaximepiton · 2025-07-07T12:45:59Z

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Last main commit: Release 1.0

Related issues

Closes #3018
Edit #2901 once this PR is merged

Description

Change the whole documentation according to what we decided all together.

If a page is changed or renamed, please check:

Search for category/ rather than /category
That the page should be singular or plural
That there is no conflict with a similar page in the section
That the links to this page are updated
That the aliases are updated
That the sitemap has been updated
That the component is still in the Storybook generation
That the title is updated accordingly

Motivation & Context

Better comprehension for users and take the complexity on our side.

Types of change

New feature (non-breaking change which adds functionality)

Live previews

https://deploy-preview-3055--boosted.netlify.app/

Checklist

Contribution

I have read the contributing guidelines

Accessibility

My change follows accessibility good practices; I have at least run axe

Design

My change respects the design guidelines defined in Orange Design System
My change is compatible with a responsive display

Development

My change follows the developer guide
I have added JavaScript unit tests to cover my changes
I have added SCSS unit tests to cover my changes

Documentation

My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

My change introduces changes to the migration guide
My new component is well displayed in Storybook
My new component is compatible with RTL
Manually run BrowserStack tests
Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
Code review
Design review
A11y review

After the merge

Manually launch Percy tests

netlify · 2025-07-07T12:47:05Z

✅ Deploy Preview for boosted ready!

Name	Link
🔨 Latest commit	`a139e96`
🔍 Latest deploy log	https://app.netlify.com/projects/boosted/deploys/695b8e69b892be0008aabed9
😎 Deploy Preview	https://deploy-preview-3055--boosted.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

hannahiss · 2025-07-09T09:23:07Z

Why not, on the homepage, add another button near "read the docs" to lead directly to components ? (or replace the button wuth "read the components doc")

hannahiss · 2025-07-09T09:31:46Z

Maybe in the docs tab, in the left menu,

rename Concept in Components by category (or something like that)
just keep this entry and not the "components" entry (since we already have the components by category, and the whole list in the components tab)

louismaximepiton · 2025-07-10T08:53:17Z

* just keep this entry and not the "components" entry (since we already have the components by category, and the whole list in the components tab)

Not quite sure to understand, do you mean the navbar link in the header should be removed ? If yes, where should the homepage button redirect ?

louismaximepiton · 2025-07-16T07:35:20Z

So as far as I understood, the idea is to remove the left menu Components part to insert it in some way inside the Components categories part, maybe via dropdowns or accordions.

louismaximepiton · 2025-07-16T07:36:01Z

We're missing an icon on the examples page

vprothais · 2025-07-16T08:00:56Z

My understanding of Hannah's proposal is to completely remove the component list from the vertical menu, since we can find them in each category and through the component entry from the horizontal menu.

Doing that would add 1 click for users in order to navigate from one component to an other. The component categories and and component list are a bit redundant but I don't see it as a problem, the understanding of "component categories" could be improved.

…dify-docs

MaxLardenois · 2025-12-29T13:44:26Z

I was just browsing and I have a UX issue with the Docs / Components tabs: when I am in the /components page with the visual list and I select one component, the Docs tab becomes active this is a little confusing tbh.
We could make it so that the Component tab is active in the header when the url contains components (but it will switch when we are in Docs and we select a component in the side bar) or completely differentiate Docs from Component with a specific sidebar for each (making it somewhat more difficult to go from components to utilities for example), like https://www.chakra-ui.com/docs/components/concepts/overview

MaxLardenois · 2025-12-29T14:26:54Z

I think we should take the opportunity to remove some pages that are currently draft and seems to me to not have a future in OUDS, like:

Components > Button group
Components > Collapse
Components > Input group
Components > List group
Components > floating-label
About > Brand

Other I'm not sure about:

Getting started > RFS (this is mostly boostrap compat no?)
Getting started > RTL (except if we plan to handle RTL in 2026)
Foundation > Color theme (this was mainly Boosted/Bootstrap)
Foundation > Figures (wouldn't this be a component?)

…dify-docs

louismaximepiton · 2025-12-30T08:47:19Z

For the pages, I'm fine with most of them, just for RTL and Collapse, I'm not sure tbh, but I'm fine with the rest to remove, maybe we can remove them in another PR ?

Co-authored-by: Maxime Lardenois <maxime.lardenois@orange.com>

vprothais · 2025-12-30T14:15:04Z

site/src/content/docs/foundation/form-validation.mdx

Since it is not a component but a wider guideline for forms, maybe we could move it to "foundation" instead.

vprothais · 2025-12-30T14:27:37Z

site/src/assets/examples/cheatsheet/index.astro

      <div class="bd-heading sticky-xl-top align-self-start mt-5 mb-3 mt-xl-0 mb-xl-2">
        <h3>Figures</h3>
-        <a class="d-flex align-items-center" href={getVersionedDocsPath('content/figures')}>Documentation</a>
+        <a class="d-flex align-items-center" href={getVersionedDocsPath('/foundation/figures')}>Documentation</a>


Not sure if it should be a foundation or a component. It it pretty close to a card.

TBH, not even sure that we will keep them, but I can set them in the components if you prefer 😄

vprothais · 2025-12-30T14:30:52Z

site/src/assets/examples/cheatsheet/index.astro

      <div class="bd-heading sticky-xl-top align-self-start mt-5 mb-3 mt-xl-0 mb-xl-2">
        <h3>Sizing</h3>
-        <a class="d-flex align-items-center" href={getVersionedDocsPath('forms/form-control#sizing')}>Documentation</a>
+        <a class="d-flex align-items-center" href="#">Documentation</a>


we could keep the link to /components/text-input/#sizing. It is a bootstrap compat feature, but make sense with this page

vprothais · 2025-12-30T14:46:16Z

site/src/content/docs/components/alerts.mdx

There are currently to type of components in the Alerts group in Figma : Alert message and Inline Alert. To stick with our logic, we should keeps the plural form.

vprothais · 2025-12-30T14:48:17Z

site/src/content/docs/components/links.mdx

There will be also the Expand link component here, shouldn't we keep the plural ?

vprothais · 2025-12-30T15:12:44Z

site/src/content/docs/foundation/component.mdx

I'm wondering if these "Customize" pages should go to foundation or to customize with a dedicated left menu. We may keep them in foundation and decide when we'll work on them later.

Customize is only a page right now, but we can make it evolve to be a category just like the others

Yeah that's what I had in mind. Making customize a category, like foundation, getting-started, ... and having a custom left menu for it with all content related to customization. But maybe part of the content of all these customization pages could be also interesting for general user to understand how it works ?

I think so indeed at least for general content like this page

vprothais · 2025-12-30T15:26:47Z

site/src/components/header/Navigation.astro

+            Layout
+          </LinkItem>
+          <LinkItem
+            active={title === 'Components' || Astro.url.pathname.includes('/components/')}


The "Components" page of the Foundation category is both active in Getting Started and Components menu, because of the Components title :/

vprothais · 2025-12-30T15:34:25Z

site/src/content/docs/components.mdx

+  ['Actions', 'Content display', 'Control', 'Data', 'Dialog', 'Indicator', 'Layout', 'Navigation', 'Visual assets'].map((element) => {
+    return (
+      <>
+        {getData('sidebar-components').filter((group) => group.title === 'Components')[0].pages.filter((page) => page?.category === element).length > 0 && <h3>{element}</h3>}


Why don't we have the category title in the TOC ? Could be handy for someone searching for a specific category.

Not quite sure how to do it, maybe I should add a component for this ? what do you think ?

Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>

Co-authored-by: Maxime Lardenois <maxime.lardenois@orange.com> Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>

louismaximepiton added the 📖 documentation Improvements or additions to documentation label Jul 7, 2025

github-project-automation bot added this to 🟣 [Orange-Boosted-Bootstrap] PRs Board Jul 7, 2025

github-project-automation bot moved this to In Progress / Draft in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jul 7, 2025

louismaximepiton marked this pull request as ready for review July 8, 2025 08:31

boosted-bot moved this from In Progress / Draft to Need Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jul 8, 2025

louismaximepiton linked an issue Jul 8, 2025 that may be closed by this pull request

[OUDS] Reorganize the documentation #3018

Open

2 tasks

louismaximepiton force-pushed the ouds/main-lmp-modify-docs branch 2 times, most recently from 815a112 to 29c0f2e Compare December 10, 2025 10:45

feat(documentation): reorganize the whole documentation

6b86746

louismaximepiton force-pushed the ouds/main-lmp-modify-docs branch from 29c0f2e to 6b86746 Compare December 10, 2025 11:09

louismaximepiton mentioned this pull request Dec 17, 2025

feat(component): Add loading state on select and text input #3278

Open

21 tasks

louismaximepiton added 9 commits December 17, 2025 11:08

Merge remote-tracking branch 'origin/ouds/main' into ouds/main-lmp-mo…

56ec14d

…dify-docs

.

5e45c88

fix ci

d2f6ecb

.

8088e6e

Merge remote-tracking branch 'origin/ouds/main' into ouds/main-lmp-mo…

4a522ee

…dify-docs

Remove useless utilities

2a8b591

.

4515a95

.

b0bdd8f

.

0908342

hannahiss closed this Dec 19, 2025

hannahiss deleted the ouds/main-lmp-modify-docs branch December 19, 2025 08:55

github-project-automation bot moved this from Need Dev Review to Done in 🟣 [Orange-Boosted-Bootstrap] PRs Board Dec 19, 2025

vprothais restored the ouds/main-lmp-modify-docs branch December 19, 2025 09:04

vprothais reopened this Dec 19, 2025

boosted-bot moved this from Done to Need Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Dec 19, 2025

Merge remote-tracking branch 'origin/ouds/main' into ouds/main-lmp-mo…

7ab4fb0

…dify-docs

louismaximepiton added 2 commits December 30, 2025 09:26

Merge remote-tracking branch 'origin/ouds/main' into ouds/main-lmp-mo…

bbeb2a9

…dify-docs

Change active underline

a13bc7e

louismaximepiton and others added 4 commits December 30, 2025 11:09

Add several sidebar files

1300de7

Co-authored-by: Maxime Lardenois <maxime.lardenois@orange.com>

.

51e76c0

.

b15ab60

fix ci

c948236

vprothais reviewed Dec 30, 2025

View reviewed changes

louismaximepiton and others added 3 commits December 31, 2025 10:20

fix(review)

6ea9b22

Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>

fix(review)

db402fd

Co-authored-by: Maxime Lardenois <maxime.lardenois@orange.com> Co-authored-by: Vincent Prothais <vincent.prothais@orange.com>

fix Sosh icons

a139e96

vprothais approved these changes Jan 5, 2026

View reviewed changes

boosted-bot moved this from Need Dev Review to Need Lead Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jan 5, 2026

vprothais merged commit a424efb into ouds/main Jan 5, 2026
13 checks passed

vprothais deleted the ouds/main-lmp-modify-docs branch January 5, 2026 10:52

github-project-automation bot moved this from Need Lead Dev Review to Done in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jan 5, 2026

louismaximepiton mentioned this pull request Jan 6, 2026

[OUDS] Improve the toc on all pages #3311

Open

2 tasks

Conversation

louismaximepiton commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Description

Motivation & Context

Types of change

Live previews

Checklist

Contribution

Accessibility

Design

Development

Documentation

Checklist (for Core Team only)

After the merge

Uh oh!

netlify bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for boosted ready!

Uh oh!

hannahiss commented Jul 9, 2025

Uh oh!

hannahiss commented Jul 9, 2025

Uh oh!

louismaximepiton commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

louismaximepiton commented Jul 16, 2025

Uh oh!

louismaximepiton commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vprothais commented Jul 16, 2025

Uh oh!

MaxLardenois commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MaxLardenois commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

louismaximepiton commented Dec 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

louismaximepiton commented Jul 7, 2025 •

edited

Loading

netlify bot commented Jul 7, 2025 •

edited

Loading

louismaximepiton commented Jul 10, 2025 •

edited

Loading

louismaximepiton commented Jul 16, 2025 •

edited

Loading

MaxLardenois commented Dec 29, 2025 •

edited

Loading

MaxLardenois commented Dec 29, 2025 •

edited

Loading