From e144aaab2bb448716a255adc05d62e7c141e1a3e Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sun, 5 Jul 2026 18:33:35 +0300 Subject: [PATCH] =?UTF-8?q?ci:=20guard=20docs=20drift=20=E2=80=94=20mkdocs?= =?UTF-8?q?=20--strict=20as=20a=20PR=20check=20+=20link/anchor=20validatio?= =?UTF-8?q?n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ports the docs CI drift guard: a parallel docs job running mkdocs --strict on PRs, a validation block so broken links/anchors and orphaned pages fail the build, and pinned docs deps. Also fixes the two orphans the omitted_files check surfaced: - adds the previously-orphaned index.md to the nav (as Overview); - relocates docs/superpowers/{specs,plans} — superpowers spec/plan artifacts mistakenly written into the mkdocs docs_dir (and published live) — into a proper planning/changes/2026-06-29.01-python-3.11-3.12-support/ bundle, where the repo convention keeps them. Those two pages 404 off the docs site after deploy, which is correct: they were internal planning docs, not user docs. Co-Authored-By: Claude Opus 4.8 (1M context) --- .github/workflows/_checks.yml | 8 ++++++++ docs/requirements.txt | 4 ++-- mkdocs.yml | 7 +++++++ .../2026-06-29.01-python-3.11-3.12-support/design.md | 7 ++++--- .../2026-06-29.01-python-3.11-3.12-support/plan.md | 0 5 files changed, 21 insertions(+), 5 deletions(-) rename docs/superpowers/specs/2026-06-29-python-3.11-3.12-support-design.md => planning/changes/2026-06-29.01-python-3.11-3.12-support/design.md (95%) rename docs/superpowers/plans/2026-06-29-python-3.11-3.12-support.md => planning/changes/2026-06-29.01-python-3.11-3.12-support/plan.md (100%) diff --git a/.github/workflows/_checks.yml b/.github/workflows/_checks.yml index e968983..e6d36a8 100644 --- a/.github/workflows/_checks.yml +++ b/.github/workflows/_checks.yml @@ -16,6 +16,14 @@ jobs: - run: uv python pin 3.13 - run: just install lint-ci + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - uses: extractions/setup-just@v4 + - uses: astral-sh/setup-uv@v8.2.0 + - run: just docs-build + pytest: runs-on: ubuntu-latest strategy: diff --git a/docs/requirements.txt b/docs/requirements.txt index 9a8a4ca..cba3dda 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -mkdocs -mkdocs-material +mkdocs>=1.6,<2 +mkdocs-material>=9,<10 diff --git a/mkdocs.yml b/mkdocs.yml index 78a4f3c..65f7949 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,7 @@ repo_url: https://github.com/modern-python/faststream-redis-timers docs_dir: docs edit_uri: edit/main/docs/ nav: + - Overview: index.md - Introduction: - Installation: introduction/installation.md - How it works: introduction/how-it-works.md @@ -50,6 +51,12 @@ theme: icon: material/brightness-4 name: Switch to system preference +validation: + omitted_files: warn + absolute_links: warn + unrecognized_links: warn + anchors: warn + markdown_extensions: - admonition - toc: diff --git a/docs/superpowers/specs/2026-06-29-python-3.11-3.12-support-design.md b/planning/changes/2026-06-29.01-python-3.11-3.12-support/design.md similarity index 95% rename from docs/superpowers/specs/2026-06-29-python-3.11-3.12-support-design.md rename to planning/changes/2026-06-29.01-python-3.11-3.12-support/design.md index f149076..f564865 100644 --- a/docs/superpowers/specs/2026-06-29-python-3.11-3.12-support-design.md +++ b/planning/changes/2026-06-29.01-python-3.11-3.12-support/design.md @@ -1,7 +1,8 @@ -# Support Python 3.11 and 3.12 +--- +summary: Lowered the supported-Python floor from 3.13 to 3.11 by backporting the PEP 695 type alias and typing.override via typing_extensions; widened the CI pytest matrix to 3.11/3.12. +--- -**Date:** 2026-06-29 -**Status:** Approved design +# Support Python 3.11 and 3.12 ## Goal diff --git a/docs/superpowers/plans/2026-06-29-python-3.11-3.12-support.md b/planning/changes/2026-06-29.01-python-3.11-3.12-support/plan.md similarity index 100% rename from docs/superpowers/plans/2026-06-29-python-3.11-3.12-support.md rename to planning/changes/2026-06-29.01-python-3.11-3.12-support/plan.md