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

Add Sass docs (variables, mixins, and loops) to most pages #32747

Merged
merged 6 commits into from
Feb 11, 2021

Conversation

mdo
Copy link
Member

@mdo mdo commented Jan 10, 2021

While reviewing #25977, figured I'd take a stab at what we could do for documenting our Sass better. This is similar to our JS docs for methods, options, etc. I think this is doable, just a little more manual than a purely generated mixins docs page.

Preview: https://deploy-preview-32747--twbs-bootstrap.netlify.app

TODO:

  • Address any comments
  • Be consistent with the Sass section place; before or after JS

This was referenced Jan 10, 2021
@mdo mdo marked this pull request as ready for review January 12, 2021 23:55
@mdo mdo requested review from a team as code owners January 12, 2021 23:55
@mdo mdo changed the title WIP: Mention variables, mixins, and loops in docs Add Sass docs (variables, mixins, and loops) to most pages Jan 12, 2021
@XhmikosR XhmikosR force-pushed the component-sass-docs branch from 99d28db to 5e5d61c Compare January 13, 2021 06:39
@XhmikosR XhmikosR requested review from a team and removed request for a team January 13, 2021 06:39
@XhmikosR
Copy link
Member

XhmikosR commented Jan 13, 2021

Looking good so far!

I wonder if it's intentional, button group does not have any Sass section. There might be more components/utilities that are missing.

EDIT: Also, do note that linkinator won't catch any missing/broken anchors. We might hit this in the future. There's a request upstream, though.

site/content/docs/5.0/forms/validation.md Outdated Show resolved Hide resolved
site/content/docs/5.0/utilities/borders.md Outdated Show resolved Hide resolved
site/content/docs/5.0/forms/overview.md Outdated Show resolved Hide resolved
site/content/docs/5.0/forms/form-control.md Outdated Show resolved Hide resolved
site/content/docs/5.0/components/spinners.md Outdated Show resolved Hide resolved
@mdo mdo mentioned this pull request Jan 13, 2021
@ffoodd ffoodd self-requested a review January 15, 2021 08:21
@XhmikosR XhmikosR marked this pull request as draft January 15, 2021 08:23
@mdo mdo mentioned this pull request Jan 16, 2021
3 tasks
@mdo mdo force-pushed the component-sass-docs branch from 1ce7225 to fa0d122 Compare February 10, 2021 16:21
@mdo mdo marked this pull request as ready for review February 10, 2021 18:28
@mdo mdo merged commit 4c7a3e8 into main Feb 11, 2021
@mdo mdo deleted the component-sass-docs branch February 11, 2021 03:30
@XhmikosR
Copy link
Member

@mdo this PR contains dis files changes :/

@mdo
Copy link
Member Author

mdo commented Feb 11, 2021

Oh woof my bad. I can revert later and fix.

@XhmikosR
Copy link
Member

@mdo yeah please revert because you committed changes that shouldn't be there :/ Remember to do npm i when deps change :)

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