Skip to content

fix: broken links reported by the learn site link check#839

Merged
henryiii merged 1 commit into
mainfrom
fix/docs-broken-links
Jul 24, 2026
Merged

fix: broken links reported by the learn site link check#839
henryiii merged 1 commit into
mainfrom
fix/docs-broken-links

Conversation

@henryiii

@henryiii henryiii commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

🤖 AI text below 🤖

The netlify-plugin-checklinks run on learn.scientific-python.org reported 4 failures in /development/, which is built from this repo. This fixes 3 of them.

  • docs/guides/docs.md: the MyST link had no scheme, so it built as the site-relative path /developmentmystmd.org and 404d.
  • docs/principles/testing.md: the explicit (unit-tests)= target collided with the implicit heading target from ## Unit tests in docs/guides/gha_basic.md. MyST resolved both {ref} uses to the GitHub Actions guide instead of the section on the same page. Renamed to unit-tests-principles.

Checked with a local myst build --html: the built page now links to #unit-tests-principles and https://mystmd.org.

The 4th failure is /development/guides/pytest#configuring-pytest. The link works; MyST writes cross-page URLs without a trailing slash and Netlify redirects, which hyperlink reports as fragment-redirect. That needs a change on the learn site, not here.


📚 Documentation preview 📚: https://scientific-python-cookie--839.org.readthedocs.build/

The MyST link in the docs guide had no scheme, so it built as the
site-relative path `/developmentmystmd.org`.

The explicit `(unit-tests)=` target in the testing principles collided
with the implicit heading target from `## Unit tests` in the GitHub
Actions guide, so both `{ref}` uses pointed at the wrong page. Rename it
to `unit-tests-principles`.

Assisted-by: ClaudeCode:claude-opus-5
@henryiii
henryiii merged commit a7437f5 into main Jul 24, 2026
8 checks passed
@henryiii
henryiii deleted the fix/docs-broken-links branch July 24, 2026 22:32
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.

1 participant