Skip to content

fix: use hyphenated page slugs in internal doc links#796

Merged
henryiii merged 1 commit into
mainfrom
henryiii/fix/doc-links-hyphens
Jun 9, 2026
Merged

fix: use hyphenated page slugs in internal doc links#796
henryiii merged 1 commit into
mainfrom
henryiii/fix/doc-links-hyphens

Conversation

@henryiii

@henryiii henryiii commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

🤖 Human guided, AI assisted PR (using this skill). AI text below. 🤖

Summary

Update all internal MyST link references to use hyphens instead of underscores to match the actual page filenames:

  • packaging_simplepackaging-simple
  • packaging_compiledpackaging-compiled
  • packaging_classicpackaging-classic
  • gha_basicgha-basic
  • gha_puregha-pure
  • gha_wheelsgha-wheels
  • repo_reviewrepo-review
  • data_filesdata-files

These links were referencing pages with underscores but the actual filenames use hyphens, so the links would have been broken.

Assisted-by: OpenCode:glm-5


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

Update all internal MyST link references to use hyphens instead of
underscores (e.g. packaging_simple → packaging-simple, gha_pure →
gha-pure, gha_wheels → gha-wheels, data_files → data-files,
repo_review → repo-review) to match the actual page filenames.

Assisted-by: OpenCode:glm-5
@henryiii henryiii merged commit bbb319a into main Jun 9, 2026
8 checks passed
@henryiii henryiii deleted the henryiii/fix/doc-links-hyphens branch June 9, 2026 04:42
henryiii added a commit to scientific-python/learn.scientific-python.org that referenced this pull request Jun 9, 2026
Use a trailing slash on BASE_URL so MyST joins it to root-relative
page links correctly (was producing /developmentpages/...), and bump
the cookie submodule to include the hyphenated-slug internal link fix
(scientific-python/cookie#796) so checklinks passes.

Assisted-by: ClaudeCode:claude-opus-4.8
henryiii added a commit to scientific-python/learn.scientific-python.org that referenced this pull request Jun 18, 2026
* Bump external-content/cookie from `4d7762b` to `228add5`

Bumps [external-content/cookie](https://github.com/scientific-python/cookie) from `4d7762b` to `228add5`.
- [Release notes](https://github.com/scientific-python/cookie/releases)
- [Commits](scientific-python/cookie@4d7762b...228add5)

---
updated-dependencies:
- dependency-name: external-content/cookie
  dependency-version: 228add5438e25e3357d0c3f9afc088ce48df25f4
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* ci: build cookie submodule with mystmd instead of jekyll

Cookie moved its docs from Jekyll to MyST in scientific-python/cookie#792.
Build the development site with `myst build --html` (BASE_URL=/development)
and drop the obsolete ruby/jekyll and repo-review-app fetch steps.

Assisted-by: ClaudeCode:claude-opus-4.8

* fix: deploy cookie under /development/ subpath correctly

Use a trailing slash on BASE_URL so MyST joins it to root-relative
page links correctly (was producing /developmentpages/...), and bump
the cookie submodule to include the hyphenated-slug internal link fix
(scientific-python/cookie#796) so checklinks passes.

Assisted-by: ClaudeCode:claude-opus-4.8

* ci: tolerate hyperlink false positives in MyST /development/ site

netlify-plugin-checklinks (hyperlink) now traverses the full cookie
site and flags two non-issues: its parser fails on MyST's bundled
mermaid chunk, and it reports valid in-page fragments as broken when
the target goes through MyST pretty-URL normalization. Mark both as
todoPatterns so real broken links still fail the build.

Assisted-by: ClaudeCode:claude-opus-4.8

* chore: bump cookie

Signed-off-by: Henry Schreiner <henryfs@princeton.edu>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Henry Schreiner <henryfs@princeton.edu>
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