From bcd30cfed05ccbd59e0cecae15c641f9a30a0b61 Mon Sep 17 00:00:00 2001
From: Wiktor Jelen <35398584+Akinzou@users.noreply.github.com>
Date: Wed, 11 Nov 2026 16:43:29 +0100
Subject: [PATCH] docs: link the documentation site at the top of the README
The link sat below the table of contents, where few readers get. It now
follows the description, with one sentence saying the site tracks master
while a PyPI release's README matches that release.
Chose the site root over deep links (/reference/, /adr/): a release's README
stays on PyPI for good, those paths sit outside what mkdocs --strict checks,
and a renamed section would turn them into permanent 404s.
---
README.md | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 63263a5..e6bddbf 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,13 @@ A safe, typed trading layer over the official
Built for bots (webhook executors, signal followers) where a trading call must
**never hang, never retry blindly, and never fail silently**.
+> **Documentation: **
+>
+> This guide, an API reference generated from the source, the architecture and
+> every design decision, searchable. The site follows the latest code on
+> master; the README of a release on PyPI, and the files it links, match that
+> release.
+
## Contents
- [Why this library](#why-this-library)
@@ -47,9 +54,6 @@ the release you are reading (ADR 0012). On PyPI the Contents entries
above do not jump to their sections; read this page on
[GitHub](https://github.com/Akinzou/MetaTrader5-Python/blob/master/README.md#contents) for that.
-Documentation site, with this guide, the API reference, the architecture and
-every ADR: .
-
Other documents: [CHANGELOG.md](https://github.com/Akinzou/MetaTrader5-Python/blob/master/CHANGELOG.md) ·
[MIGRATION.md](https://github.com/Akinzou/MetaTrader5-Python/blob/master/MIGRATION.md) · [docs/architecture.md](https://github.com/Akinzou/MetaTrader5-Python/blob/master/docs/architecture.md) ·
[docs/adr](https://github.com/Akinzou/MetaTrader5-Python/tree/master/docs/adr)