Add skeleton for adapter docs (#402)

* add sceleton for adapter docs * update docs
airtai · Oct 15, 2024 · 120e683 · 120e683
1 parent ee3f8f3
commit 120e683
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 5 deletions.
diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -18,7 +18,7 @@ search:
         - [FastAPI](user-guide/ui/fastapi/basics.md)
     - [Adapters](user-guide/adapters/index.md)
         - [FastAPI](user-guide/adapters/fastapi/index.md)
-        - [Nats.io](user-guide/adapters/nats/index.md)
+        - [NATS.io](user-guide/adapters/nats/index.md)
     - [API-s](user-guide/api/index.md)
         - [OpenAPI](user-guide/api/openapi/index.md)
         - [Security](user-guide/api/security.md)

diff --git a/docs/docs/en/user-guide/adapters/fastapi/index.md b/docs/docs/en/user-guide/adapters/fastapi/index.md
@@ -1,3 +1,3 @@
 # FastAPI
 
-TBD
+**FastAPI** allows for a fairly scalable setup using [**FastAPI**](https://fastapi.tiangolo.com/){target="_blank"} to execute your workflows. It supports execution with multiple workers, with each workflow being executed in the context of a WebSocket connection.
diff --git a/docs/docs/en/user-guide/adapters/index.md b/docs/docs/en/user-guide/adapters/index.md
@@ -1,3 +1,18 @@
 # Network Adapters
 
-TBD
+FastAgency can use chainable network adapters that can be used to easily create
+scalable, production ready architectures for serving your workflows.
+
+## Available Adapters
+
+### FastAPI
+
+Use the [**`FastAPIAdapter`**](../api/fastagency/adapters/fastapi/FastAPIAdapter.md) to serve your workflow using [**FastAPI**](https://fastapi.tiangolo.com/){target="_blank"} server. This setup allows you to work your workflows in multiple workers and serve them using the highly extensible and stable ASGI server.
+
+[Learn more about **FastAPI** →](./fastapi/)
+
+### Nats.io
+
+Utilize the [**`NatsAdapter`**](../api/fastagency/adapters/nats/NatsAdapter.md) to use [**NATS.io MQ**](https://nats.io/){target="_blank"} message broker for highly-scalable, production-ready setup. This interface is suitable for setups in VPN-s or, in combination with the [**`FastAPIAdapter`**](../api/fastagency/adapters/fastapi/FastAPIAdapter.md) to serve public workflows in an authenticated, secure manner.
+
+[Learn more about **NATS.io** →](./nats/)
diff --git a/docs/docs/en/user-guide/adapters/nats/index.md b/docs/docs/en/user-guide/adapters/nats/index.md
@@ -1,3 +1,3 @@
 # NATS.io
 
-TBD
+This is the most scalable setup using a distributed message broker [**NATS.io MQ**](https://nats.io/){target="_blank"}. Workflows are being executed with multiple workers that attach to the MQ waiting for initiate workflow messages. Such workers can be running on different machines or even different data centers/cloud providers. Message queues are highly scalable, but more difficult to integrate with end-clients. In order to make such integrations easier, we will connect our [**NATS**](https://nats.io/){target="_blank"}-based message queue with the [**FastAPI**](https://fastapi.tiangolo.com/){target="_blank"} application.
diff --git a/docs/docs/navigation_template.txt b/docs/docs/navigation_template.txt
@@ -18,7 +18,7 @@ search:
         - [FastAPI](user-guide/ui/fastapi/basics.md)
     - [Adapters](user-guide/adapters/index.md)
         - [FastAPI](user-guide/adapters/fastapi/index.md)
-        - [Nats.io](user-guide/adapters/nats/index.md)
+        - [NATS.io](user-guide/adapters/nats/index.md)
     - [API-s](user-guide/api/index.md)
         - [OpenAPI](user-guide/api/openapi/index.md)
         - [Security](user-guide/api/security.md)