Skip to content

docs: style integration - #591

Merged
paulinea merged 10 commits into
developfrom
472-update-documentation-homepage
Jul 2, 2025
Merged

docs: style integration#591
paulinea merged 10 commits into
developfrom
472-update-documentation-homepage

Conversation

@MaxLardenois

@MaxLardenois MaxLardenois commented Jun 23, 2025

Copy link
Copy Markdown
Collaborator

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

Related issues

closes #472

Description

Integration of the style made by the design team

Motivation & Context

As we can only add a css, we cannot import OUDS Web.

Types of change

  • New feature (non-breaking change which adds functionality)

Previews

Checklist

Contribution

Accessibility

  • My change follows accessibility good practices

Design

  • My change respects the design guidelines of Orange Unified Design System

Development

  • My change follows the developer guide
  • I have added unit tests to cover my changes (optional)

Documentation

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

Checklist (for Core Team only)

  • Manually test (dark mode, RTL, landscape display, tablet)
  • Documentation has been updated if relevant
  • Design review
  • A11y review
  • Internal files have been updated if relevant (THIRD_PARTY, NOTICE)
  • changelog.md has been updated respecting keep a changelog rules and referencing the issue

@MaxLardenois MaxLardenois linked an issue Jun 23, 2025 that may be closed by this pull request
@MaxLardenois

MaxLardenois commented Jun 23, 2025

Copy link
Copy Markdown
Collaborator Author

A note on the homepage

In order to add the hero image and introductory text we have to select on the actual text in the page which is not optimal. We could lose the style (and hero image) if the text changes or we could wrongly add it on another page if we have the same text. This is not a big issue but to keep in mind if that happens.

@MaxLardenois

MaxLardenois commented Jun 23, 2025

Copy link
Copy Markdown
Collaborator Author

TOC sidebar styling

  • It is not possible to put the hover zone on the whole links, the chevron and the link itself are different elements.
  • It is not possible easily to change the background color of the mobile sidebar, it is tied to the dark mode and the navbar in the DOM. I kept it black.

@MaxLardenois

MaxLardenois commented Jun 23, 2025

Copy link
Copy Markdown
Collaborator Author

Max-width question
In OUDS we have a max-with on text elements (paragraphs for example), which I added also here.
The margins on the main are different than the design because if we want to have these margins they will apply to the code examples as well, which might not be optimal.

Without max-width on the main container:

Capture d’écran 2025-06-25 à 11 09 38

With max-width:

Capture d’écran 2025-06-25 à 11 09 20

Please let me know what solution you prefer

@MaxLardenois

MaxLardenois commented Jun 23, 2025

Copy link
Copy Markdown
Collaborator Author

Cards as subpages
The design uses cards for links sub-pages ("All modules", "Packages" lists). This is hardly feasible with Dokka DOM and would have many side-effects in the rest of the documentation.

@github-actions

github-actions Bot commented Jun 23, 2025

Copy link
Copy Markdown

🟢 Netlify deploy for commit 3843408 succeeded

Deploy preview: null
Deploy log: https://app.netlify.com/projects/ouds-android/deploys/686552fce75a9aa8072bb643

@MaxLardenois
MaxLardenois marked this pull request as ready for review June 25, 2025 09:43
@MaxLardenois

Copy link
Copy Markdown
Collaborator Author

Header/Navbar on mobile/tablet
It was not possible to have the same result on the navigation header as we have in OUDS because of the DOM generated by Dokka. The buttons cannot be in the same line as the icon nor can it be pushed to the Menu dropdown.
This is the best I could do

Capture d’écran 2025-06-25 à 13 02 38

@louismaximepiton louismaximepiton left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link hover in dark mode seems broken.

Some small issues with some colors, but the rendering looks good already.

Comment thread docs/assets/orange-style.css Outdated
Comment thread docs/assets/orange-style.css Outdated
Comment thread docs/assets/orange-style.css Outdated

@louismaximepiton louismaximepiton left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just taking notes of the presentation:

  • The menu on mobile looks bugged a bit once a page is selected
  • The run-button (play button) should be removed
  • Something about the title

@paulinea

paulinea commented Jul 2, 2025

Copy link
Copy Markdown
Member

@MaxLardenois When I take a look at the Netlify preview I see several problems:

  • menu hover color is a dark grey
  • the homepage banner is not displayed
Capture d’écran 2025-07-02 à 16 13 48

@paulinea
paulinea merged commit 5a0ee8d into develop Jul 2, 2025
9 checks passed
@paulinea
paulinea deleted the 472-update-documentation-homepage branch July 2, 2025 16:16
paulinea added a commit that referenced this pull request Jul 4, 2025
* docs: style integration

* docs: update doc style

* docs: update introduction position as in design

* feat: various dark mode fixes

* fix: toc hover color

* fix: toc hover color

* chore: add hero banner in dokka build

* Update NOTICE.txt file

---------

Co-authored-by: Pauline Auvray <pauline.auvray@orange.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation homepage

3 participants