Skip to content
GitLab

Docs: consistent usage of CSS sections in /helpers, /layout

Open Julien Déramond requested to merge main-jd-docs-consistent-usage-of-css-sections-step-2 into main

Description

Following https://github.com/twbs/bootstrap/pull/38175, this PR suggests more modifications in the way we display CSS and Sass info globally in our docs:

  • Most of the time, I've integrated when not already there a surrounding "CSS" section
  • I've systematically used the plural form for the section titles (even if they contained only 1 element):
    • "Sass mixin" → "Sass mixins"
    • "Sass loop" → "Sass loops"
    • "Sass map" → "Sass maps"
  • So it means that I also changed the URLs impacted by these modifications
  • In order to keep the same spirit of "Sass variables", "Sass mixins", "Sass loops":
    • "Utilities" → "Sass utilities API"
    • "Utilities API" → "Sass utilities API"

To summarize, here's the new structure:

## CSS
### Variables
### Sass variables
### Sass maps
### Sass mixins
### Sass loops
### Sass utilities API

Note Regardingsite/content/docs/5.3/layout/css-grid.md, I decided to let it as is because the content is really linked to a limitation and doesn't seem to fit our regular CSS section.

Hope I haven't broken too much links in the process 😇

Motivation & Context

Docs headings global consistency around CSS and Sass.

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