More docs fixes #39741
Merged
More docs fixes #39741
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
XhmikosR
commented
Mar 5, 2024
| @@ -186,7 +186,7 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt | |||
| | `allowList` | object | [Default value]({{< docsref "/getting-started/javascript#sanitizer" >}}) | Object which contains allowed attributes and tags. | | |||
| | `animation` | boolean | `true` | Apply a CSS fade transition to the popover. | | |||
| | `boundary` | string, element | `'clippingParents'` | Overflow constraint boundary of the popover (applies only to Popper's preventOverflow modifier). By default, it's `'clippingParents'` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper's [detectOverflow docs](https://popper.js.org/docs/v2/utils/detect-overflow/#boundary). | | |||
| | `container` | string, element, false | `false` | Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize. | | |||
| | `container` | string, element, false | `false` | Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize. | | |||
There was a problem hiding this comment.
This is unrelated but I noticed it and I changed it to the entity so that it's clearer. Unsure if it has any effect anyway, but I hate confusing characters because this looked like a normal space.
There was a problem hiding this comment.
TBH I don't know why we'd need a non-breaking space in this specific case, but I trust your judgment. It doesn't have any side effect.
XhmikosR
commented
Mar 5, 2024
| @@ -126,7 +126,7 @@ composer require twbs/bootstrap:{{< param current_version >}} | |||
|
|
|||
| ### NuGet | |||
|
|
|||
| If you develop in .NET Framework, you can also install and manage Bootstrap's [CSS](https://www.nuget.org/packages/bootstrap/) or [Sass](https://www.nuget.org/packages/bootstrap.sass/) and JavaScript using [NuGet](https://www.nuget.org/). Newer projects should use [libman](https://docs.microsoft.com/en-us/aspnet/core/client-side/libman/) or another method as NuGet is designed for compiled code, not frontend assets. | |||
| If you develop in .NET Framework, you can also install and manage Bootstrap's [CSS](https://www.nuget.org/packages/bootstrap/) or [Sass](https://www.nuget.org/packages/bootstrap.sass/) and JavaScript using [NuGet](https://www.nuget.org/). Newer projects should use [libman](https://learn.microsoft.com/en-us/aspnet/core/client-side/libman/) or another method as NuGet is designed for compiled code, not frontend assets. | |||
There was a problem hiding this comment.
This still leads to a redirect but I think it's better to not tie to a specific version and we save one redirect.
julien-deramond
approved these changes
Mar 6, 2024
There was a problem hiding this comment.
Just a minor modification to maybe do regarding the Popper links in 2 JS files and our README. The rest LGTM! Good enhancements!
Just out of curiosity, did you use any tools to find that some URLs needed to be updated because of the redirections, or was it a manual test one by one?
| @@ -10,7 +10,7 @@ toc: true | |||
|
|
|||
| Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They're made interactive with the included Bootstrap dropdown JavaScript plugin. They're toggled by clicking, not by hovering; this is [an intentional design decision](https://markdotto.com/2012/02/27/bootstrap-explained-dropdowns/). | |||
|
|
|||
| Dropdowns are built on a third party library, [Popper](https://popper.js.org/), which provides dynamic positioning and viewport detection. Be sure to include [popper.min.js]({{< param "cdn.popper" >}}) before Bootstrap's JavaScript or use `bootstrap.bundle.min.js` / `bootstrap.bundle.js` which contains Popper. Popper isn't used to position dropdowns in navbars though as dynamic positioning isn't required. | |||
| Dropdowns are built on a third party library, [Popper](https://popper.js.org/docs/v2/), which provides dynamic positioning and viewport detection. Be sure to include [popper.min.js]({{< param "cdn.popper" >}}) before Bootstrap's JavaScript or use `bootstrap.bundle.min.js` / `bootstrap.bundle.js` which contains Popper. Popper isn't used to position dropdowns in navbars though as dynamic positioning isn't required. | |||
There was a problem hiding this comment.
The URL is changed for each Markdown file, which is perfect.
There are remaining occurrences that might be changed too:
- In
README.mdso that it redirects to Popper and not Floating UI - In
js/src/dropdown.jsandjs/src/tooltip.jsto have access to the right documentation if needed
| @@ -186,7 +186,7 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt | |||
| | `allowList` | object | [Default value]({{< docsref "/getting-started/javascript#sanitizer" >}}) | Object which contains allowed attributes and tags. | | |||
| | `animation` | boolean | `true` | Apply a CSS fade transition to the popover. | | |||
| | `boundary` | string, element | `'clippingParents'` | Overflow constraint boundary of the popover (applies only to Popper's preventOverflow modifier). By default, it's `'clippingParents'` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper's [detectOverflow docs](https://popper.js.org/docs/v2/utils/detect-overflow/#boundary). | | |||
| | `container` | string, element, false | `false` | Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize. | | |||
| | `container` | string, element, false | `false` | Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize. | | |||
There was a problem hiding this comment.
TBH I don't know why we'd need a non-breaking space in this specific case, but I trust your judgment. It doesn't have any side effect.
Add missing ones and add the ability to show or hide the badge Fixes a few more 404 errors in the version picker
|
We use linkinator for internal links only right now. We could use it for external links too, but it results to many false positives. So, I mostly use https://validator.w3.org/checklink and https://www.drlinkcheck.com/ ignoring robots.txt on the main branch's Netlify preview. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview: https://deploy-preview-39741--twbs-bootstrap.netlify.app/
Split from #39724