ci(docs): add markdown link check job and fix broken links- Closes #132 - #230
Open
afshan-khan549 wants to merge 1 commit into
Open
ci(docs): add markdown link check job and fix broken links- Closes #132#230afshan-khan549 wants to merge 1 commit into
afshan-khan549 wants to merge 1 commit into
Conversation
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
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.
Summary
Adds a
docs-link-checkCI job (per #132) that runsmarkdown-link-checkonPRs and weekly against
main, and fixes the broken links it found in theprocess.
Changes
.github/workflows/docs-link-check.yml— new workflow runninggaurav-nelson/github-action-markdown-link-checkon PRs targetingmainand on a weekly schedule
.github/mlc_config.json— link-checker config: ignores localhost URLs,sets a browser-like User-Agent for GitHub URLs, treats
429as alive(rate-limit tolerance), and ignores MkDocs clean-URL-style relative links
(e.g.
getting-started/quickstart/) indocs/index.md, which are validonce the site is built via
mkdocs buildbut aren't real raw file pathsREADME.md— fixed the "Stars" badge link, which pointed to/stargazers, a route that 404s on GitHub for this repo (confirmed also404s on
torvalds/linux/stargazers, so likely a broader GitHub behaviorchange); now links to the repo root instead
SUPPORT.md— removed the "Community" section linking to GitHubDiscussions, which is disabled for this repo (
has_discussions: falsevia the GitHub API)
Testing
Ran
markdown-link-checklocally against every.mdfile in the repo(via
npx markdown-link-check --config .github/mlc_config.json) beforeand after the fixes:
README.mdstargazers badge,SUPPORT.mddiscussions link) + 13 false-positive failures on MkDocsclean URLs in
docs/index.mdNo Python code was changed, so
ruff/mypy/pytest/banditare notapplicable to this PR.
Checklist
ci/docs-link-check-132— followingthe
cicommit-type convention, since a dedicatedci/branch prefixisn't listed in the branch-naming table)
mainAGENT.mdcoding standards — N/A, no Python code changeddomain/andports/stay pure — N/A, no Python code changedruff,mypy --strict,bandit,pytest— N/A, no Python code changedpyproject.tomlandsrc/modeldock/__init__.pyversions match — N/A, not release-related