From 37bfceddf4d67e52e20d471d08b4b5ec5485b5d7 Mon Sep 17 00:00:00 2001 From: Martin Barotto Date: Thu, 10 Sep 2026 08:59:19 -0300 Subject: [PATCH] docs(readme): use absolute repo URLs so PyPI links resolve MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README is the PyPI project description (readme = "README.md"), which PyPI renders in isolation with no repository context. Relative Markdown links are emitted verbatim by PyPI's renderer, so they resolve against the project page URL and 404 for anyone landing from pip: - the "original README" link (README-general.md) — now the only place the usage docs live for this deprecation release - the license badge's link target and the prose LICENSE link Rewrite all three as absolute URLs pinned to the v1.0.84 tag (blob/v1.0.84/...) rather than a branch, so they stay valid if files move or the branch is renamed. Prose, headings, the deprecation warning, and the already-absolute links (docs.hydrolix.io, mailto) are unchanged. Note: these URLs 404 until the v1.0.84 tag is created and pushed. Co-Authored-By: Claude Opus 4.8 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 41cb149..43915ef 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Hydrolix clusters. ## Usage documentation -See the [original README](README-general.md) for installation and usage +See the [original README](https://github.com/hydrolix/hdxcli/blob/v1.0.84/README-general.md) for installation and usage instructions. > [!NOTE] @@ -27,8 +27,8 @@ Success](mailto:support@hydrolix.io). ## License -[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/hydrolix/hdxcli/blob/v1.0.84/LICENSE) This project is licensed under the terms of the **Apache License 2.0**. You -can find a copy of the license in the [LICENSE](LICENSE) file included in this +can find a copy of the license in the [LICENSE](https://github.com/hydrolix/hdxcli/blob/v1.0.84/LICENSE) file included in this repository.