ci(docs): 🔗 add source and post-build docs link checks - #53
Draft
matteoacrossi wants to merge 5 commits into
Draft
ci(docs): 🔗 add source and post-build docs link checks#53matteoacrossi wants to merge 5 commits into
matteoacrossi wants to merge 5 commits into
Conversation
Add lychee-based docs link checking for both source MDX (internal links) and built HTML output (including external links), and wire both checks into the documentation workflow. Update docs commands in README accordingly. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Roberto Di Remigio Eikås <robertodr@users.noreply.github.com>
Member
|
@matteoacrossi are you still interested in getting this merged? |
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.
Why
The docs pipeline did not enforce broken-link checks, so invalid links could slip through. We need link validation both before build (fast feedback on docs sources) and after build (final exported HTML correctness, including external URLs).
What changed
lycheefor docs MDX/Markdown:.lychee.toml(offline/internal-focused settings)just check-doc-linksrecipe.lychee.postbuild.toml(external links enabled, bounded retries/timeouts)just check-doc-links-builtrecipe (runs afterbuild-docs)docpages.ymlto run both checks in CI:README.mdwith the new docs link-check commands.Notes for reviewers