Changed git actions, fixed examples in docs

Author: mr-fatalyst

.github/CONTRIBUTING.md

@@ -10,6 +10,7 @@ This guide explains how to get started, make contributions, write commits, open
 Install dependencies with:
 
 ```bash
+# Fork the repo on GitHub first, then:
 git clone https://github.com/yourusername/fastopenapi.git
 cd fastopenapi
 poetry install

.github/workflows/master-deploy.yml

@@ -6,7 +6,32 @@ on:
       - 'v*'
 
 jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup environment (coverage)
+        uses: ./.github/actions/setup-env
+        with:
+          python-version: "3.10"
+          install-flags: "--all-extras"
+
+      - name: Run tests with coverage
+        run: |
+          poetry run coverage run -m pytest
+          poetry run coverage report
+          poetry run coverage xml
+
+      - name: Upload coverage to Codecov
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: bash <(curl -s https://codecov.io/bash) -t $CODECOV_TOKEN -f coverage.xml
+
   deploy-prod:
+    needs: coverage
     runs-on: ubuntu-latest
     env:
       POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/master.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches:
       - master
+    paths-ignore:
+      - 'benchmarks/**'
+      - 'docs/**'
+      - 'examples/**'
 
 jobs:
   lint:
@@ -38,28 +42,3 @@ jobs:
 
       - name: Run tests
         run: poetry run pytest
-
-  coverage:
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Setup environment (coverage)
-        uses: ./.github/actions/setup-env
-        with:
-          python-version: "3.10"
-          install-flags: "--all-extras"
-
-      - name: Run tests with coverage
-        run: |
-          poetry run coverage run -m pytest
-          poetry run coverage report
-          poetry run coverage xml
-
-      - name: Upload coverage to Codecov
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        run: bash <(curl -s https://codecov.io/bash) -t $CODECOV_TOKEN -f coverage.xml

README.md

@@ -306,7 +306,7 @@ http://127.0.0.1:8000/redoc
 
 ## 📖 Documentation
 
-Explore the [Docs](https://github.com/mr-fatalyst/fastopenapi/blob/master/docs/en/index.md) for an overview of FastOpenAPI, its core components, and usage guidelines. The documentation is continuously updated and improved.
+Explore the [Docs](https://fastopenapi.fatalyst.dev/) for an overview of FastOpenAPI, its core components, and usage guidelines. The documentation is continuously updated and improved.
 
 ---
 

docs/de/docs/advanced/api_reference.md

@@ -48,13 +48,119 @@ fastopenapi/
 
 Jedes unterstützte Framework hat einen eigenen Router, der von `BaseRouter` erbt:
 
-- **AioHttpRouter**
-- **FalconRouter**
-- **FlaskRouter**
-- **QuartRouter**
-- **SanicRouter**
-- **StarletteRouter**
-- **TornadoRouter**
+### AioHttpRouter
+
+```python
+from aiohttp import web
+from fastopenapi.routers import AioHttpRouter
+
+app = web.Application()
+router = AioHttpRouter(app=app)
+
+@router.get("/status")
+async def status():
+    return {"status": "ok"}
+```
+
+---
+
+### FalconRouter
+
+```python
+import falcon.asgi
+from fastopenapi.routers import FalconRouter
+
+app = falcon.asgi.App()
+router = FalconRouter(app=app)
+
+@router.get("/status")
+async def status():
+    return {"status": "ok"}
+```
+
+---
+
+### FlaskRouter
+
+```python
+from flask import Flask
+from fastopenapi.routers import FlaskRouter
+
+app = Flask(__name__)
+router = FlaskRouter(app=app)
+
+@router.get("/hello")
+def hello(name: str):
+    return {"message": f"Hello {name}"}
+```
+
+---
+
+### QuartRouter
+
+```python
+from quart import Quart
+from fastopenapi.routers import QuartRouter
+
+app = Quart(__name__)
+router = QuartRouter(app=app)
+
+@router.get("/ping")
+async def ping():
+    return {"pong": True}
+```
+
+---
+
+### SanicRouter
+
+```python
+from sanic import Sanic
+from fastopenapi.routers import SanicRouter
+
+app = Sanic("MySanicApp")
+router = SanicRouter(app=app)
+
+@router.get("/info")
+async def info():
+    return {"framework": "Sanic", "status": "running"}
+```
+
+---
+
+### StarletteRouter
+
+Use for Starlette integration.
+
+```python
+from starlette.applications import Starlette
+from fastopenapi.routers import StarletteRouter
+
+app = Starlette()
+router = StarletteRouter(app=app)
+
+@router.get("/check")
+async def check():
+    return {"status": "healthy"}
+```
+
+---
+
+### TornadoRouter
+
+Use for Tornado integration.
+
+```python
+from tornado.web import Application
+from fastopenapi.routers import TornadoRouter
+
+app = Application()
+router = TornadoRouter(app=app)
+
+@router.get("/status")
+def status():
+    return {"running": True}
+```
 
 ---
 

docs/de/docs/contributing.md

@@ -10,6 +10,7 @@ Dieses Dokument erklärt, wie du loslegen kannst, Beiträge leistest, Commits er
 Installiere Abhängigkeiten mit:
 
 ```bash
+# Fork the repo on GitHub first, then:
 git clone https://github.com/yourusername/fastopenapi.git
 cd fastopenapi
 poetry install

docs/en/docs/contributing.md

@@ -10,6 +10,7 @@ This guide explains how to get started, make contributions, write commits, open
 Install dependencies with:
 
 ```bash
+# Fork the repo on GitHub first, then:
 git clone https://github.com/yourusername/fastopenapi.git
 cd fastopenapi
 poetry install
@@ -48,6 +49,7 @@ Tests cover both internal logic and integration with aiohttp, flask, sanic, and
 ## Code Style
 
 This project uses:
+
 - `black` — code formatting
 - `flake8` — linting
 - `isort` — import sorting

docs/es/docs/advanced/api_reference.md

@@ -48,17 +48,122 @@ fastopenapi/
 
 ## Routers por framework
 
-FastOpenAPI ofrece una clase de router por framework:
+FastOpenAPI ofrece una clase de router por framework.
+Cada uno extiende `BaseRouter` y adapta las rutas a las interfaces específicas del framework.
 
-- `AioHttpRouter`
-- `FalconRouter`
-- `FlaskRouter`
-- `QuartRouter`
-- `SanicRouter`
-- `StarletteRouter`
-- `TornadoRouter`
+### AioHttpRouter
 
-Cada uno extiende `BaseRouter` y adapta las rutas a las interfaces específicas del framework.
+```python
+from aiohttp import web
+from fastopenapi.routers import AioHttpRouter
+
+app = web.Application()
+router = AioHttpRouter(app=app)
+
+@router.get("/status")
+async def status():
+    return {"status": "ok"}
+```
+
+---
+
+### FalconRouter
+
+```python
+import falcon.asgi
+from fastopenapi.routers import FalconRouter
+
+app = falcon.asgi.App()
+router = FalconRouter(app=app)
+
+@router.get("/status")
+async def status():
+    return {"status": "ok"}
+```
+
+---
+
+### FlaskRouter
+
+```python
+from flask import Flask
+from fastopenapi.routers import FlaskRouter
+
+app = Flask(__name__)
+router = FlaskRouter(app=app)
+
+@router.get("/hello")
+def hello(name: str):
+    return {"message": f"Hello {name}"}
+```
+
+---
+
+### QuartRouter
+
+```python
+from quart import Quart
+from fastopenapi.routers import QuartRouter
+
+app = Quart(__name__)
+router = QuartRouter(app=app)
+
+@router.get("/ping")
+async def ping():
+    return {"pong": True}
+```
+
+---
+
+### SanicRouter
+
+```python
+from sanic import Sanic
+from fastopenapi.routers import SanicRouter
+
+app = Sanic("MySanicApp")
+router = SanicRouter(app=app)
+
+@router.get("/info")
+async def info():
+    return {"framework": "Sanic", "status": "running"}
+```
+
+---
+
+### StarletteRouter
+
+Use for Starlette integration.
+
+```python
+from starlette.applications import Starlette
+from fastopenapi.routers import StarletteRouter
+
+app = Starlette()
+router = StarletteRouter(app=app)
+
+@router.get("/check")
+async def check():
+    return {"status": "healthy"}
+```
+
+---
+
+### TornadoRouter
+
+Use for Tornado integration.
+
+```python
+from tornado.web import Application
+from fastopenapi.routers import TornadoRouter
+
+app = Application()
+router = TornadoRouter(app=app)
+
+@router.get("/status")
+def status():
+    return {"running": True}
+```
 
 ---
 

docs/es/docs/contributing.md

@@ -10,6 +10,7 @@ Esta guía explica cómo comenzar, realizar aportes, escribir commits, abrir pul
 Instala las dependencias con:
 
 ```bash
+# Fork the repo on GitHub first, then:
 git clone https://github.com/yourusername/fastopenapi.git
 cd fastopenapi
 poetry install