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: consistent usage of CSS sections #38175

Merged
merged 2 commits into from
Mar 13, 2023

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Mar 6, 2023

Description

Based on 20ab821 and our recent modifications around custom properties, some sections are sometimes called Sass, Sass variables, CSS, etc.

Based on similar files in these folders, this PR suggests modifications to have consistent "CSS" + "Sass variables" sections in:

  • /components
  • /content
  • /forms

Based on similar files in these folders, this PR suggests modifications to have consistent "Sass mixins" sections in:

  • /components

Based on similar files in these folders, this PR suggests modifications to have consistent "Sass loop" sections in:

  • /components

Warning
Not knowing exactly the global approach, this PR doesn't modify remaining ## Sass$ occurrences in /helpers, /layout, and /utilities.

Type of changes

  • Refactoring (non-breaking change)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • (N/A) I have added tests to cover my changes
  • All new and existing tests passed

Live previews

@louismaximepiton
Copy link
Member

louismaximepiton commented Mar 6, 2023

I think some are missing in:

  • ratio.md, not sure about this one
  • containers.md
  • css-grid.md
  • almost each in utilities/**.md

We should also unify our ## Utilities API title ?

@julien-deramond
Copy link
Member Author

julien-deramond commented Mar 6, 2023

Yep, this is what I've mentioned in the description, in the warning message. This PR treats only the things I'm sure about but I can modify the rest of it of course if we state exactly what direction we want to take. @mdo thoughts here?

@mdo
Copy link
Member

mdo commented Mar 10, 2023

@julien-deramond If you want to update those other pages, including the API heading, feel free!

@julien-deramond
Copy link
Member Author

julien-deramond commented Mar 13, 2023

So I'm merging this one already reviewed and I'll create another PR so that I can suggest something.
Edit: See #38219

@julien-deramond julien-deramond merged commit c57be44 into main Mar 13, 2023
@julien-deramond julien-deramond deleted the main-jd-docs-consistent-usage-of-css-sections branch March 13, 2023 10:41
@mahilanmjd mahilanmjd mentioned this pull request Apr 16, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants