From 7afae8866bc0f22a7e3c7ff6f98e1935ef995512 Mon Sep 17 00:00:00 2001 From: "h.nejati" Date: Mon, 26 Oct 2026 18:32:40 +0330 Subject: [PATCH 1/2] ci: check links in docs and README --- .github/workflows/link-check.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/link-check.yml diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml new file mode 100644 index 00000000..d3f74fb2 --- /dev/null +++ b/.github/workflows/link-check.yml @@ -0,0 +1,26 @@ +name: Link check + +on: + pull_request: + branches: [master] + paths: + - 'docs/**' + - 'README.md' + - '.github/workflows/link-check.yml' + schedule: + - cron: "0 4 * * 1" # Mondays at 4:00 UTC + workflow_dispatch: + +permissions: + contents: read + +jobs: + link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - uses: lycheeverse/lychee-action@v2 + with: + args: --no-progress --max-retries 2 --accept 200,429 --exclude 'localhost' --exclude '127\.0\.0\.1' 'README.md' 'docs/**/*.md' + fail: true From b4b1f267f38989235d34da72ff28086be53756d7 Mon Sep 17 00:00:00 2001 From: "h.nejati" Date: Mon, 26 Oct 2026 18:35:36 +0330 Subject: [PATCH 2/2] docs: fix dead links found by the link check --- README.md | 14 +++++++------- docs/index.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 00a8f388..08ce2646 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # ArchiPy - Architecture + Python [![Forks](https://img.shields.io/github/forks/SyntaxArc/ArchiPy)](https://github.com/SyntaxArc/ArchiPy/network/members) -[![Stars](https://img.shields.io/github/stars/SyntaxArc/ArchiPy)](https://github.com/SyntaxArc/ArchiPy/stargazers) +[![Stars](https://img.shields.io/github/stars/SyntaxArc/ArchiPy)](https://github.com/SyntaxArc/ArchiPy) [![Python](https://img.shields.io/badge/Python-3.14+-blue.svg)](https://www.python.org/downloads/) [![UV](https://img.shields.io/badge/UV-package%20manager-blue)](https://docs.astral.sh/uv/) [![Documentation](https://img.shields.io/badge/docs-MkDocs-blue.svg)](https://syntaxarc.github.io/ArchiPy/) @@ -63,7 +63,7 @@ ArchiPy is built with the following objectives in mind: 5. **Behavior-Driven Development (BDD) Support** - Enable robust feature validation 6. **Best Practices & Development Structure** - Enforce coding standards -[Read more about ArchiPy's architecture and design](https://syntaxarc.github.io/ArchiPy/architecture) +[Read more about ArchiPy's architecture and design](https://syntaxarc.github.io/ArchiPy/getting-started/concepts/) --- @@ -76,7 +76,7 @@ ArchiPy is built with the following objectives in mind: - **BDD Testing**: Fully integrated Behave setup - **Modern Tooling**: Dependency management and code quality tools -[Explore the complete feature set](https://syntaxarc.github.io/ArchiPy/features) +[Explore the complete feature set](https://syntaxarc.github.io/ArchiPy/api_reference/) --- @@ -105,7 +105,7 @@ uv add archipy uv add archipy[redis,fastapi] ``` -[View installation documentation](https://syntaxarc.github.io/ArchiPy/installation) +[View installation documentation](https://syntaxarc.github.io/ArchiPy/getting-started/installation/) --- @@ -124,7 +124,7 @@ pip install archipy[postgres] # PostgreSQL support Each adapter extra installs its own package (`archipy[redis]` → `archipy-redis`), so only the adapters you ask for are installed. Imports are unchanged (`archipy.adapters.redis`). -[See the documentation for all available options and examples](https://syntaxarc.github.io/ArchiPy/usage) +[See the documentation for all available options and examples](https://syntaxarc.github.io/ArchiPy/tutorials/) --- @@ -143,7 +143,7 @@ make behave make lint ``` -[View the complete development guide](https://syntaxarc.github.io/ArchiPy/development) +[View the complete development guide](https://syntaxarc.github.io/ArchiPy/community/contributing/) --- @@ -207,6 +207,6 @@ make docs-build-full make docs-deploy ``` -**See [DOCS_QUICKSTART.md](DOCS_QUICKSTART.md) for more commands and tips.** +**See [the quickstart](https://syntaxarc.github.io/ArchiPy/getting-started/quickstart/) for more commands and tips.** [View the latest documentation](https://syntaxarc.github.io/ArchiPy/) diff --git a/docs/index.md b/docs/index.md index 1f0753b8..0e1ab2f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ description: Introduction to ArchiPy and installation guide for the framework an [![Python versions](https://img.shields.io/pypi/pyversions/archipy)](https://pypi.org/project/archipy/) [![License](https://img.shields.io/pypi/l/archipy)](community/license.md) [![Downloads](https://img.shields.io/pypi/dm/archipy)](https://pypi.org/project/archipy/) -[![CI](https://github.com/SyntaxArc/ArchiPy/actions/workflows/ci.yml/badge.svg)](https://github.com/SyntaxArc/ArchiPy/actions) +[![CI](https://github.com/SyntaxArc/ArchiPy/actions/workflows/tests.yml/badge.svg)](https://github.com/SyntaxArc/ArchiPy/actions) [![GitHub Stars](https://img.shields.io/github/stars/SyntaxArc/ArchiPy?style=social)](https://github.com/SyntaxArc/ArchiPy) ArchiPy is a Python framework that provides standardized, scalable building blocks for modern applications.