docs: link to the versioned documentation index - #33
Merged
Conversation
The README and the package metadata pointed at /MitmLibraryKeywords.html, which is only written when a release is published. Until the first release under the new workflow that path does not exist, so both links answered 404 - and the site index, which does exist and lists every published version, was linked only as an afterthought. They now point at the index, which is the entry point and is valid whether or not a release has been published yet. The direct links to the latest release and to the current main stay, below it. The bare path keeps being published on release, because the metadata of every already published version points at it, back to 0.1. Nothing in the repository links there any more, but those releases cannot be changed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Small follow-up to #32, worth landing before the 1.0.0 tag because the package metadata it changes ships in the release.
The README and
pyproject.tomlpointed at/MitmLibraryKeywords.html, which is only written when a release is published. Until the first release under the new workflow that path does not exist, so both links answer 404 today — and the site index, which does exist and lists every published version, was linked only as an afterthought.They now point at the index, which is the entry point and is valid whether or not a release has been published. The direct links to the latest release and to current main stay, below it.
The bare path keeps being published on release: the metadata of every already published version points at it, back to 0.1, and those releases cannot be changed. The workflow comment now says that, rather than claiming the README points there.
Verified against the live site:
/,/dev/MitmLibraryKeywords.htmland/versions.jsonreturn 200;/MitmLibraryKeywords.htmland/latest/return 404 until the first release tag.🤖 Generated with Claude Code