Skip to content

docs: point repo links at the versioned /latest/ docs paths - #206

Merged
LukasGold merged 1 commit into
mainfrom
docs/versioned-doc-links
Sep 22, 2026
Merged

LukasGold merged 1 commit into
mainfrom
docs/versioned-doc-links

Conversation

@LukasGold

Copy link
Copy Markdown
Contributor

Changes

File Was Now
README.md line 26 /get-started/ /latest/get-started/
README.md line 53 /tools/ /latest/tools/
README.md line 60 /get-started/#logging /latest/get-started/#logging
CONTRIBUTING.md line 22 /dev/ /latest/dev/

Rationale

The documentation deploys with mike, which serves every page under a version
directory. The gh-pages root holds only a redirect to latest/. Unversioned
deep links therefore do not resolve to the intended page:

  • /get-started/ returns 404.
  • /tools/ returns 200, but serves the Sphinx page frozen at 2026-07-07. A
    directory from the pre-mike deployment still sits at the gh-pages root. A
    200 here does not mean the link is correct.
  • /dev/ returns 200, but serves mike's dev version home page, not the
    development guide. mike's version name dev collides with the page
    docs/dev.md. The guide is at /latest/dev/.

This became visible only after
#201 was fixed. The site
had been serving a 2026-07-07 build, so no documentation URL resolved
correctly.

Not changed

Links to the bare root stay unversioned, because mike set-default --push latest writes the root redirect:

  • README.md lines 4 and 16
  • pyproject.toml Documentation
  • CITATION.cff url

Verification

Every opensemanticlab.github.io/osw-python URL remaining in the repository
was fetched with curl. All five return 200. The #logging anchor resolves to
<h2 id="logging">Logging, the section describing OSW_LOG_LEVEL.

Related

- mike serves pages only under version directories; the root is a redirect
- README /get-started/ was a 404, /tools/ served the superseded July build
- CONTRIBUTING /dev/ resolved to mike's dev version, not the dev guide
- root links in pyproject.toml and CITATION.cff stay unversioned
@github-actions

Copy link
Copy Markdown
Contributor

Release preview

No version bump from the current commits (stays at v2.7.1). Use conventional commit types (feat, fix, ...) to trigger a release.

Changelog preview (truncated)

Preview via python-semantic-release and conventional commits.

@LukasGold
LukasGold merged commit c21ad24 into main Sep 22, 2026
12 checks passed
@LukasGold
LukasGold deleted the docs/versioned-doc-links branch September 22, 2026 14:37
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