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: Better indicate include options in sass setup. #41143

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Kelketek
Copy link

@Kelketek Kelketek commented Jan 7, 2025

Description

This change makes a light improvement to the docs on including additional modules in Sass.

Motivation & Context

I'm in the middle of an upgrade, and I just spent the last several hours trying to track down why my custom variables for forms weren't working only to realize that the list of includes on the Sass page was not intended to be comprehensive, but only examples of sass sheets one might want to import, and that one should go through the sass directory to find any components they may yet need.

The changes I'm proposing here would have saved me a few hours, so I imagine they'll help a few other folks, too :)

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

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
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

https://deploy-preview-41143--twbs-bootstrap.netlify.app/ (Pending CI)

@mdo
Copy link
Member

mdo commented Jan 12, 2025

That's fair, easy improvement here.

@@ -70,14 +70,15 @@ In your `custom.scss`, you'll import Bootstrap's source Sass files. You have two
@import "../node_modules/bootstrap/scss/mixins";
@import "../node_modules/bootstrap/scss/root";

// 6. Optionally include any other parts as needed
// 6. Optionally include any other parts as needed. More includes can be found in the same directory as these examples.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// 6. Optionally include any other parts as needed. More includes can be found in the same directory as these examples.
// 6. Include any other optional stylesheet partials as desired; list below is not inclusive of all available stylesheets

Copy link
Member

Choose a reason for hiding this comment

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

Shucks, I don't have edit access so can't merge this suggestion myself.

Copy link
Author

Choose a reason for hiding this comment

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

@mdo I've squashed in your suggestion and re-pushed!

@Kelketek Kelketek force-pushed the fox/improve-sass-includes-instructions branch from c789588 to d558cd0 Compare January 13, 2025 22:32
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.

2 participants