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
Reusable Sass utilities API documentation section #39756
base: main
Are you sure you want to change the base?
Conversation
- call the partial from the shortcode to not introduces a breaking change
- use it in the Overflow doc as example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @guilhermejcgois for this PR!
I haven't had the time to look at everything. Just made 2 quick comments based on recent modifications we've done in the docs.
I'll look at it more closely this week.
Overflow utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]({{< docsref "/utilities/api#using-the-api" >}}) | ||
|
||
{{< scss-docs name="utils-overflow" file="scss/_utilities.scss" >}} | ||
{{< sass-utilities-api-section title="Overflow" name="utils-overflow" file="scss/_utilities.scss" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an edge case I haven't seen before in borders.md
where there are two calls to scss-docs
:
{{< scss-docs name="utils-borders" file="scss/_utilities.scss" >}}
{{< scss-docs name="utils-border-radius" file="scss/_utilities.scss" >}}
Let's perhaps wait for the discussion on the global approach to take place and not tackle it right away if it's too complicated, but here we might need to manage an array of names instead of a simple name="utils-overflow"
.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, some refactoring is happening in our docs right now. I haven't voluntarily clicked on "Update branch" to avoid breaking your changes. I'll let you rebase your branch yourself and adapt your changes to the latest modifications. This site/layouts/shortcodes/docsref.html
might for instance be impacted depending on when you've created this branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Certainly! When the refactoring is over, I can rebase my branch. Are you tracking these refactorings in any issue? If you think it's safe, I can do it as soon as I can and look at the borders.md issue as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can rebase it from now on. There's no tracking issue; it's basically all the commits from this week and last week. They won't probably have any impacts on your PR directly, but some elements would maybe need to be backported here; I'll take care of it when the PR is rebased as it might be difficult and long for you to handle :)
Description
I separated the change into 3 parts:
Type of changes
Checklist
npm run lint
)Live previews
Related issues
Closes #38434