Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add <details><summary> to hide design callouts #2548

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Apr 23, 2024

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

Related issues

NA

Description

Added small CSS to handle these hidden parts.
Some design callouts weren't hidden for understanding of the doc (navs&tabs, navbar, introduction, badge and so on).

Summary used in the doc for the details summary:
See Bootstrap example(s) incompatible with Orange Design System

Several questions to answer before merging this:

  • Is the design ok?
  • Is the information loss fine?

Motivation & Context

Following the refactoring of buttons and dropdowns.
Avoid polluting the user experience.

Types of change

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

Live previews

Checklist

Contribution

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

@louismaximepiton louismaximepiton added v5 docs Improvements or additions to documentation labels Apr 23, 2024
Copy link

netlify bot commented Apr 23, 2024

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit b9c80fa
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/666c14f9d425920008a6a063
😎 Deploy Preview https://deploy-preview-2548--boosted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

Wording should be reviewed sometimes.
The details summary should mention the incompatibility with ODS.

site/assets/scss/_content.scss Outdated Show resolved Hide resolved
site/content/docs/5.3/components/badge.md Show resolved Hide resolved
site/content/docs/5.3/components/badge.md Show resolved Hide resolved
site/content/docs/5.3/components/breadcrumb.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/button-group.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/dropdowns.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/progress.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/dropdowns.md Show resolved Hide resolved
site/content/docs/5.3/components/progress.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/spinners.md Show resolved Hide resolved
Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

Missing some details on pages in utilities, like colors, links, ....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation v5
Projects
Status: Need Dev Review
Development

Successfully merging this pull request may close these issues.

None yet

2 participants