docs: fix relative link to version.py in the release README by 1816586742-stack · Pull Request #8441 · mitmproxy/mitmproxy · GitHub
Skip to content

docs: fix relative link to version.py in the release README - #8441

Open
1816586742-stack wants to merge 1 commit into
mitmproxy:mainfrom
1816586742-stack:docs/fix-version-py-link
Open

1816586742-stack wants to merge 1 commit into
mitmproxy:mainfrom
1816586742-stack:docs/fix-version-py-link

Conversation

@1816586742-stack

Copy link
Copy Markdown

What

Fix the relative link to mitmproxy/version.py in the release README.

Why

The last step of the release checklist links to the version file like this:

[...](mitmproxy/version.py) and add a `.dev` suffix.

Relative to release/README.md, that target resolves to release/mitmproxy/version.py, which does not exist — the link 404s. The file is at the repository root:

$ git ls-files | grep 'mitmproxy/version.py$'
mitmproxy/version.py

One character class of fix — the target now starts with ../ and resolves to the file that actually exists.

Verification

  • mitmproxy/version.py exists at the repository root
  • the only other link in this file is an absolute https:// URL, so nothing else in it is affected
  • checked every relative link in release/*.md: this was the only broken one

I kept the visible link text unchanged so the diff stays to one line; if you would rather simplify the text to version.py at the same time, say the word and I will fold it in.

The link target was written as mitmproxy/version.py, which from release/
resolves to release/mitmproxy/version.py and therefore 404s. Point it at
the file at the repository root, which is where it actually lives.

@lups2000 lups2000 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks :)

@lups2000

lups2000 commented Oct 1, 2026

Copy link
Copy Markdown
Member

This branch has not been deployed

No deployments
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.

2 participants