Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down Expand Up @@ -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/)

---

Expand All @@ -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/)

---

Expand Down Expand Up @@ -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/)

---

Expand All @@ -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/)

---

Expand All @@ -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/)

---

Expand Down Expand Up @@ -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/)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading