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 caption in captions' html examples #2033

Merged
merged 2 commits into from
May 30, 2023
Merged

Conversation

hannahiss
Copy link
Member

@hannahiss hannahiss commented May 12, 2023

Add caption in captions' html examples so that developers can see how to use it
Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Description

Add captions in html code example

Motivation & Context

In captions' section, we have 2 examples with caption, but no caption in the html example.

Types of change

  • Bug fix (non-breaking which fixes an issue)

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 responsive display

Development

  • My change follows the developer guide
  • (NA) I have added JavaScript unit tests to cover my changes
  • (NA) 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
  • (NA) My new component is added in Storybook
  • (NA) My new component is compatible with RTL
  • (NA) Manually run BrowserStack tests
  • (NA) 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

@hannahiss hannahiss marked this pull request as ready for review May 12, 2023 15:37
@netlify
Copy link

netlify bot commented May 12, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 52b9ca9
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/646dd3670f647100089e2100
😎 Deploy Preview https://deploy-preview-2033--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 settings.

@hannahiss hannahiss added docs Improvements or additions to documentation fix labels May 12, 2023
Copy link
Contributor

@MewenLeHo MewenLeHo left a comment

Choose a reason for hiding this comment

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

Good catch!

Just a question: the captions are present in Bootstrap (https://getbootstrap.com/docs/5.2/content/tables/#captions) meaning they were intentionnaly removed from Boosted. Do we know why? And when?

Because if it was trully intentional there was probably a reason to do it? (honestly I don't see any good reason to do it 🤔 )

@hannahiss
Copy link
Member Author

hannahiss commented May 15, 2023

Just a question: the captions are present in Bootstrap (https://getbootstrap.com/docs/5.2/content/tables/#captions) meaning they were intentionnaly removed from Boosted. Do we know why? And when?

Because if it was trully intentional there was probably a reason to do it? (honestly

Good question... I've been digging: it seems it comes from #859

@louismaximepiton @julien-deramond Was it an error to remove captions in displayed code?

@hannahiss hannahiss closed this May 15, 2023
@hannahiss hannahiss reopened this May 15, 2023
@hannahiss
Copy link
Member Author

hannahiss commented May 23, 2023

(answer from LM who has issues with Github access these days)

meaning they were intentionnaly removed from Boosted. Do we know why? And when?

Good catch Hannah, it comes from #859.

FWIW, I tried to bring much Bootstrap commits inside this PR such as the table shortcode so it had many impacts on the table.md and I missed the one here. It was surely unintentional to remove the caption code in the demo caption section so it would be great to see it back in the doc!

@hannahiss hannahiss requested a review from MewenLeHo May 23, 2023 09:32
Copy link
Contributor

@MewenLeHo MewenLeHo left a comment

Choose a reason for hiding this comment

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

LGTM with LM's answer.

@sonarcloud
Copy link

sonarcloud bot commented May 24, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@julien-deramond julien-deramond merged commit dbed1d2 into main May 30, 2023
@julien-deramond julien-deramond deleted the his-tables-caption branch May 30, 2023 06:54
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 fix
Projects
Development

Successfully merging this pull request may close these issues.

3 participants