Skip to content

Docs: correct the stale opt-in claims for the CSS Grid system - #43176

Open
ump45nose wants to merge 4 commits into
twbs:mainfrom
ump45nose:docs-cssgrid-enabled-by-default
Open

ump45nose wants to merge 4 commits into
twbs:mainfrom
ump45nose:docs-cssgrid-enabled-by-default

Conversation

@ump45nose

@ump45nose ump45nose commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Description

The v6 docs still describe the CSS Grid system as opt-in and "disabled by default", but $enable-cssgrid has defaulted to true since the v6 alpha (scss/_config.scss:36: $enable-cssgrid: true !default;), so the .grid classes ship enabled. This PR updates the three stale statements to say the system is enabled by default and explains how to disable it instead:

  • site/src/content/docs/layout/css-grid.mdx — the warning callout, the "optional grid system" sentence and the first "How it works" bullet, plus the frontmatter description ("Learn how to enable…").
  • site/src/content/docs/utilities/grid.mdx — the info callout.

The $enable-cssgrid row in the options table (customize/options.mdx) is intentionally not touched here, since #42427 already covers it.

Motivation & Context

A user following the current docs would set $enable-cssgrid: true believing they are enabling an optional feature, when the grid is already active in their build. Verified against the shipped v6.0.0-alpha.1 dist CSS, which contains the .grid classes.

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly

Checklist

Testing

Docs-only change. Verified $enable-cssgrid: true !default; in scss/_config.scss, that scss/layout/_grid.scss gates .grid generation on it, and that no open PR covers these two files (#42427 only touches customize/options.mdx; #42784 refactors grid mechanics without touching the opt-in text).

$enable-cssgrid defaults to true since v6 (scss/_config.scss), so the
CSS Grid classes ship enabled. Update the css-grid and grid utilities
pages, which still said the system is opt-in and disabled by default,
and reword the instructions to describe how to disable it instead.
@julien-deramond julien-deramond added v6 v6, the main branch docs Documentation site and its content labels Oct 23, 2026
@ump45nose

Copy link
Copy Markdown
Contributor Author

Branch is behind main. Updating from base to keep CI current.

@julien-deramond

Copy link
Copy Markdown
Member

Please don't rebase each time there are modifications in `main' (except if there are conflicts to handle). Otherwise it generates notifications and potential CI run for nothing :)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation site and its content v6 v6, the main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants