Fix/docusaurus build warnings - #392
Open
gerbsen wants to merge 3 commits into
Open
Conversation
gerbsen
force-pushed
the
fix/docusaurus-build-warnings
branch
from
August 5, 2026 14:23
89f80fb to
4a1a09c
Compare
Running `npm start` emitted three classes of warning that we control: - `siteConfig.onBrokenMarkdownLinks` is deprecated and removed in Docusaurus v4. Moved it to `siteConfig.markdown.hooks.onBrokenMarkdownLinks`, keeping the `warn` severity so broken markdown links are still reported. - All seven blog posts lacked a truncation marker, so the blog list pages rendered each post in full. Added `<!-- truncate -->` after the opening paragraph of each post. - Duplicate route at `/standards/`: the vendored standards content pulled in by getDocs.js ships a README.md, which Docusaurus renders at the same route as our own standards/index.md. The standards docs plugin now excludes that README so index.md is unambiguously the page at `/standards/`. The remaining seven "Markdown link ... couldn't be resolved" warnings all originate in gitignored content vendored from upstream repositories, so they have to be fixed in those repositories rather than here. Committed with --no-verify: the pre-commit hook runs `markdownlint-cli2-fix`, a binary that markdownlint-cli2 v0.22 no longer ships. `prettier --check` and `markdownlint-cli2` were both run manually against these changes and pass. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
gerbsen
force-pushed
the
fix/docusaurus-build-warnings
branch
from
August 7, 2026 09:57
4a1a09c to
c04d33c
Compare
mbuechse
reviewed
Aug 7, 2026
- Add User-Agent header for lwn.net in mlc_config.json to avoid 401 responses from the markdown link checker - Add scs-health-monitor docs to docs.package.json so referenced files are fetched during the build Signed-off-by: Daniel Gerber <394442-gerbsen@users.noreply.gitlab.com>
gerbsen
force-pushed
the
fix/docusaurus-build-warnings
branch
from
August 7, 2026 14:25
7f92afb to
aaa4c45
Compare
mbuechse
reviewed
Aug 7, 2026
| // own standards/index.md. Skip it; index.md is the page we want there. | ||
| // Repeats Docusaurus' default excludes, which this option replaces. | ||
| exclude: [ | ||
| 'README.md', |
Contributor
There was a problem hiding this comment.
Why was this not necessary before?
Or is this a preliminary step before we alter getDocs.js to not delete README.md?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I was a little annoyed by all the warnings once you start the server, so I thought it might be a good idea to get rid of them. There were quite a lot of links which I manually resolved to new pages due to the osism removal and archival of the health-monitor repo. I also bumped the version of Docusaurus to the most recent one: works on my machinel™.
One thing I would like to change in the future: brokens links are considered a real problem and break the complete build process. I think if we already have the possibility to check that all links work, then we should use it.