DO NOT MERGE!!! Experimenting

.github/workflows/docs_check-broken-links.yaml

@@ -15,6 +15,6 @@ jobs:
       - name: Check links using container
         uses: ruzickap/action-my-broken-link-checker@v2
         with:
-          url: https://faststream.airt.ai
+          url: https://dummy.faststream.airt.ai
           cmd_params: '--buffer-size=8192 --max-connections=1 --color=always --header="User-Agent:Mozilla/5.0(Firefox/97.0)" --exclude="(localhost:8000|linkedin.com|fonts.gstatic.com|reddit.com)" --max-connections-per-host=1 --rate-limit=1 --max-response-body-size=20000000'
           debug: true

.github/workflows/docs_deploy.yaml

@@ -12,6 +12,7 @@ on:
 permissions:
   contents: write
 
+
 jobs:
   deploy_docs:
     runs-on: ubuntu-latest

.github/workflows/pr_tests.yaml

@@ -38,14 +38,6 @@ jobs:
           path: ~/.cache/pre-commit
           key: pre-commit|${{ hashFiles('.pre-commit-config.yaml') }}
       - uses: pre-commit/[email protected]
-        continue-on-error: true
-        with:
-          extra_args: --hook-stage manual --all-files
-      - name: Commit
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: "fix: add missing pre-commit changes"
-      - uses: pre-commit/[email protected]
 
   test-basic:
     if: github.event.pull_request.draft == false

.github/workflows/docs_update-references.yaml → .github/workflows/pr_update_linting_and_api_references.yaml

@@ -1,13 +1,11 @@
-name: Generate API References documentation
+name: Run linting, update API References and commit changes
 
 on:
   pull_request_target:
     types:
       - opened
       - synchronize
       - ready_for_review
-    paths:
-      - faststream/**
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -17,7 +15,7 @@ permissions:
   contents: write
 
 jobs:
-  check-docs-changes:
+  check-linting-and-docs-changes:
     if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     steps:
@@ -32,13 +30,19 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
+      - name: Set $PY environment variable
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
       - name: Install Dependencies
         if: steps.cache.outputs.cache-hit != 'true'
         shell: bash
         # should install with `-e`
         run: |
           set -ux
           uv pip install --system -e .[dev]
+      - uses: pre-commit/[email protected]
+        continue-on-error: true
+        with:
+          extra_args: --hook-stage manual --all-files
       - name: Run build docs
         run: bash scripts/build-docs.sh
       - name: Commit

.pre-commit-config.yaml

@@ -68,3 +68,4 @@ repos:
     -   id: detect-secrets
         args: ['--baseline', '.secrets.baseline']
         exclude: package.lock.json
+        stages: [pre-commit, pre-merge-commit, manual]

docs/docs/SUMMARY.md

@@ -581,6 +581,11 @@ search:
                     - [build_message](api/faststream/confluent/testing/build_message.md)
             - constants
                 - [ContentTypes](api/faststream/constants/ContentTypes.md)
+            - dummy
+                - [Double](api/faststream/dummy/Double.md)
+                - [Dummy](api/faststream/dummy/Dummy.md)
+                - [Strange](api/faststream/dummy/Strange.md)
+                - [Twice](api/faststream/dummy/Twice.md)
             - exceptions
                 - [AckMessage](api/faststream/exceptions/AckMessage.md)
                 - [FastStreamException](api/faststream/exceptions/FastStreamException.md)

docs/docs/en/api/faststream/dummy/Double.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.dummy.Double

docs/docs/en/api/faststream/dummy/Dummy.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.dummy.Dummy

docs/docs/en/api/faststream/dummy/Strange.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.dummy.Strange

docs/docs/en/api/faststream/dummy/Twice.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.dummy.Twice

docs/docs/en/redis/index.md

@@ -30,7 +30,7 @@ In contrast, [**Redis List**](https://redis.io/docs/data-types/lists/#common-use
 
 #### 3. Streams
 
-[**Redis Streams**](https://redis.io/docs/data-types/streams/){.external-link target="_blank"} introduce a more advanced concept, embracing an append-only log-like structure. Messages, organized as entries, allow for nuanced features like consumer groups, enabling parallel processing, and acknowledgment for precise message handling. Streams excel in scenarios demanding scalability, persistence, and ordered message processing.
+[**Redis Streams**](https://redis.io/docs/latest/develop/data-types/streams/){.external-link target="_blank"} introduce a more advanced concept, embracing an append-only log-like structure. Messages, organized as entries, allow for nuanced features like consumer groups, enabling parallel processing, and acknowledgment for precise message handling. Streams excel in scenarios demanding scalability, persistence, and ordered message processing.
 
 Ultimately, the choice between **Pub/Sub**, **List**, or **Streams** hinges on the specific needs of the application. Redis Pub/Sub suits real-time communication, List offers simplicity in ordered processing, while Streams cater to complex, scalable, and ordered message handling, each providing tailored solutions based on distinct use case requirements.
 

docs/docs/en/redis/streams/index.md

@@ -10,7 +10,7 @@ search:
 
 # Redis Streams
 
-[Redis Streams](https://redis.io/docs/data-types/streams/){.external-link target="_blank"} are a data structure introduced in **Redis 5.0** that offer a reliable and highly scalable way to handle streams of data. They are similar to logging systems like **Apache Kafka**, where data is stored in a log structure and can be consumed by multiple clients. **Streams** provide a sequence of ordered messages, and they are designed to handle a high volume of data by allowing partitioning and multiple consumers.
+[Redis Streams](https://redis.io/docs/latest/develop/data-types/streams/){.external-link target="_blank"} are a data structure introduced in **Redis 5.0** that offer a reliable and highly scalable way to handle streams of data. They are similar to logging systems like **Apache Kafka**, where data is stored in a log structure and can be consumed by multiple clients. **Streams** provide a sequence of ordered messages, and they are designed to handle a high volume of data by allowing partitioning and multiple consumers.
 
 A **Redis Stream** is a collection of entries, each having an ID (which includes a timestamp) and a set of key-value pairs representing the message data. Clients can add to a stream by generating a new entry and can read from a stream to consume its messages.
 

faststream/dummy.py

@@ -0,0 +1,30 @@
+class Dummy:
+    def __init__(self) -> None:
+        pass
+
+    def dummy_method(self) -> str:
+        return "dummy"
+
+
+class Strange:
+    def __init__(self) -> None:
+        pass
+
+    def strange_method(self) -> str:
+        return "strange"
+
+
+class Twice:
+    def __init__(self) -> None:
+        pass
+
+    def twice_method(self) -> str:
+        return "twice"
+
+
+class Double:
+    def __init__(self) -> None:
+        pass
+
+    def double_method(self) -> str:
+        return "double"