Skip to content

docs: enable strict mode for broken link checking #123

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

Merged
merged 1 commit into from
May 8, 2025

Conversation

mrbojangles3
Copy link
Contributor

No description provided.

@mrbojangles3 mrbojangles3 requested review from a team as code owners May 7, 2025 18:16
@mrbojangles3 mrbojangles3 requested a review from pau-hedgehog May 7, 2025 18:16
Copy link

github-actions bot commented May 7, 2025

🚀 Deployed on https://preview-123--hedgehog-docs.netlify.app

@github-actions github-actions bot temporarily deployed to pull request May 7, 2025 18:16 Inactive
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Great to have these fixes! Not sure about making --strict a default just yet though, see below.

@Frostman
Copy link
Member

Frostman commented May 7, 2025

It doesn't break the serve command, it's still INFO level:

docs on  strict_docs_build [$] took 4s810ms 
15:16:14 ➜  just serve
[15:16:17] docker run -q --pull=always --rm -v $(pwd):/docs -p 8000:8000 ghcr.io/githedgehog/hhdocs:20241202 mkdocs serve --strict -a 0.0.0.0:8000
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Doc file 'reference/fab-api.md' contains a link '#prefix', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fab-api.md' contains a link '#addr', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fab-api.md' contains a link '#prefixordhcp', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fab-api.md' contains a link '#fabricmode', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fab-api.md' contains a link '#alloyconfig', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fab-api.md' contains a link '#version', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fabric-api.md' contains a link '#map[string]switchstatebgpneighbor', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fabric-api.md' contains a link '#map[string]vpcpeer', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fabric-api.md' contains a link '#nostype', but there is no such anchor on this page.
INFO    -  Doc file 'reference/fabric-api.md' contains a link '#redundancytype', but there is no such anchor on this page.
INFO    -  Documentation built in 3.38 seconds
INFO    -  [22:16:23] Watching paths for changes: 'docs', 'mkdocs.yml', 'includes', 'overrides'
INFO    -  [22:16:23] Serving on http://0.0.0.0:8000/

@qmonnet
Copy link
Member

qmonnet commented May 8, 2025

Ah, I forgot about that. OK, fine by me in that case

Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks!

@mrbojangles3 mrbojangles3 merged commit 0018928 into master May 8, 2025
4 checks passed
@mrbojangles3 mrbojangles3 deleted the strict_docs_build branch May 8, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants