docs: new index and pages

Adriano Santos · Adriano Santos · commit 249299df7115 · 2025-01-07T21:08:20.000-03:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -134,6 +134,6 @@ The Spawn protocol is very simple to implement but it is necessary for the devel
 
 **Don't forget to subscribe to our [Discord](https://discord.gg/2PcshvfS93) server and we wish you a good hack**.
 
-[Next: History](docs/history.md)
+[Next: Local Development](docs/local_development.md)
 
-[Previous: Protocol](docs/protocol.md)
+[Previous: Contribution Guilde](docs/contribution_guide.md)
diff --git a/docs/activators.md b/docs/activators.md
@@ -4,6 +4,6 @@ TODO
 
 [Back to Index](index.md)
 
-[Next: Observability](observability.md)
+[Next: Operator Manual](operator_manual.md)
 
 [Previous: Statestores](statestores.md)
diff --git a/docs/actors.md b/docs/actors.md
@@ -448,4 +448,10 @@ end
 
 * **Stateless Actors**: Simpler to implement and scale, as they do not require persistence mechanisms or consistent state handling.
 
-By supporting both stateful and stateless behaviors, Spawn provides the flexibility needed to design distributed systems that efficiently balance complexity, scalability, and functionality.
+By supporting both stateful and stateless behaviors, Spawn provides the flexibility needed to design distributed systems that efficiently balance complexity, scalability, and functionality.
+
+[Back to Index](index.md)
+
+[Next: Projections](projections.md)
+
+[Previous: Architecture](architecture.md)
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -32,6 +32,6 @@ In turn, each Sidecar container within a POD organizes itself to form an Erlang
 
 [Back to Index](index.md)
 
-[Next: Conceptual](conceptual.md)
+[Next: Actors](actors.md)
 
-[Previous: Overview](overview.md)
+[Previous: Developer Guide](developer_guide.md)
diff --git a/docs/conceptual.md b/docs/conceptual.md
@@ -85,6 +85,6 @@ platform.
 
 [Back to Index](index.md)
 
-[Next: Features](features.md)
+[Next: Main Concepts](main.md)
 
-[Previous: Overview](architecure.md)
+[Previous: History](history.md)
diff --git a/docs/contribution_guide.md b/docs/contribution_guide.md
@@ -0,0 +1,9 @@
+# Contribution Guide
+
+TODO
+
+[Back to Index](index.md)
+
+[Next: Contributing](../CONTRIBUTING.md)
+
+[Previous: Observability](observability.md)
diff --git a/docs/crds.md b/docs/crds.md
@@ -26,4 +26,4 @@ Spawn defines some custom Resources for the user to interact with the API for de
 
 [Next: Actor System Resource](crds/actor_system.md)
 
-[Previous: SDKs](sdks.md)
+[Previous: Install](install.md)
diff --git a/docs/crds/activator.md b/docs/crds/activator.md
@@ -1,6 +1,6 @@
 # Activator Resource
 TODO
 
-[Next: Statestores](../statestores.md)
+[Next: Observability](../observability.md)
 
-[Previous: Actor System Resource](actor_system.md)
+[Previous: Actor Host Resource](actor_host.md)
diff --git a/docs/developer_guide.md b/docs/developer_guide.md
@@ -0,0 +1,9 @@
+# Developer Guide
+
+TODO
+
+[Back to Index](index.md)
+
+[Next: Architecture](architecture.md)
+
+[Previous: Getting Started](getting_started.md)
diff --git a/docs/durable.md b/docs/durable.md
@@ -4,6 +4,4 @@ TODO
 
 [Back to Index](index.md)
 
-[Next: Protocol](protocol.md)
-
-[Previous: Main Concepts](main.md)
+[Previous: Modeling Systems with Actors](modeling_with_actors.md)
diff --git a/docs/features.md b/docs/features.md
@@ -61,6 +61,6 @@
 
 [Back to Index](index.md)
 
-[Next: Install](install.md)
+[Next: SDKs](sdks.md)
 
-[Previous: Architecture](architecture.md)
+[Previous: Projections](projections.md)
diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -337,6 +337,6 @@ In the next section, you'll find links to each supported SDK.
 
 [Back to Index](index.md)
 
-[Next: SDKs](sdks.md)
+[Next: Developer Guide](developer_guide.md)
 
-[Previous: Install](install.md)
+[Previous: Overview](overview.md)
diff --git a/docs/history.md b/docs/history.md
@@ -37,6 +37,6 @@ Eigr Spawn being based on Erlang/OTP and running on the BEAM is an excellent fit
 
 [Back to Index](index.md)
 
-[Next: Index](index.md)
+[Next: Conceptual](conceptual.md)
 
-[Previous: Contributing](../CONTRIBUTING.md)
+[Previous: Miscellaneous](miscellaneous.md)
diff --git a/docs/index.md b/docs/index.md
@@ -1,26 +1,67 @@
 # Table of Contents
 
 01. [Overview](overview.md)
-02. [Architecture](architecture.md)
-     - 3.1 [Conceptual](conceptual.md)
-03. [Features](features.md)
-04. [Install](install.md)
-05. [Getting Started](getting_started.md)
-06. [SDKs](sdks.md)
-07. [Custom Resources](crds.md)
-    - 7.1. [Actor System Resource](crds/actor_system.md) 
-    - 7.2. [Actor Host Resource](crds/actor_host.md)
-    - 7.3. [Activator Resource](crds/activator.md)
-08. [Statestores](statestores.md)
-09. [Activators](activators.md)
-10. [Observability](observability.md)
-11. [Local Development](local_development.md)
-12. [Main Concepts](main.md)
-13. [Durable Computing](durable.md)
-14. [Protocol](protocol.md)
-15. [Contributing](../CONTRIBUTING.md)
-16. [History](history.md)
-17. [Modeling Systems with Actors](modeling_with_actors.md)
+02. [Getting Started](getting_started.md)
+03. [Developer Guide](developer_guide.md)
+    - 3.1 [Architecture](architecture.md)
+    - 3.2 [Actors](actors.md)
+    - 3.3 [Projections](projections.md)
+    - 3.4 [Features](features.md)
+    - 3.4 [SDKs](sdks.md)
+        - 3.4.1 [Dart](sdks/dart/getting_started.md)
+            - [Actors](sdks/dart/actors.md)
+            - [Invoking Actors](sdks/dart/actor_invocation.md)
+            - [Workflows](sdks/dart/workflows.md)
+            - [Projections](sdks/dart/projections.md)
+        - 3.4.2 [Elixir](sdks/elixir/getting_started.md)
+            - [Actors](sdks/elixir/actors.md)
+            - [Invoking Actors](sdks/elixir/actor_invocation.md)
+            - [Workflows](sdks/elixir/workflows.md)
+            - [Projections](sdks/elixir/projections.md)
+        - 3.4.3 [Go](sdks/go/getting_started.md)
+            - [Actors](sdks/go/actors.md)
+            - [Invoking Actors](sdks/go/actor_invocation.md)
+            - [Workflows](sdks/go/workflows.md)
+            - [Projections](sdks/go/projections.md)
+        - 3.4.4 [Java](sdks/java/getting_started.md)
+            - [Actors](sdks/java/actors.md)
+            - [Invoking Actors](sdks/java/actor_invocation.md)
+            - [Workflows](sdks/java/workflows.md)
+            - [Projections](sdks/java/projections.md)
+        - 3.4.5 [Node](sdks/node/getting_started.md)
+            - [Actors](sdks/node/actors.md)
+            - [Invoking Actors](sdks/node/actor_invocation.md)
+            - [Workflows](sdks/node/workflows.md)
+            - [Projections](sdks/node/projections.md)
+        - 3.4.6 [Python](sdks/python/getting_started.md)
+            - [Actors](sdks/python/actors.md)
+            - [Invoking Actors](sdks/python/actor_invocation.md)
+            - [Workflows](sdks/python/workflows.md)
+            - [Projections](sdks/python/projections.md)
+        - 3.4.7 [Rust](sdks/rust/getting_started.md)
+            - [Actors](sdks/rust/actors.md)
+            - [Invoking Actors](sdks/rust/actor_invocation.md)
+            - [Workflows](sdks/rust/workflows.md)
+            - [Projections](sdks/rust/projections.md)
+    - 3.5 [Statestores](statestores.md)
+    - 3.6 [Activators](activators.md)
+04. [Operator Manual](operator_manual.md)
+    - 4.1 [Install](install.md)
+    - 4.2 [Custom Resources](crds.md)
+        - 4.2.1 [Actor System Resource](crds/actor_system.md) 
+        - 4.2.2 [Actor Host Resource](crds/actor_host.md)
+        - 4.2.3 [Activator Resource](crds/activator.md)
+    - 4.3 [Observability](observability.md)
+05. [Contributing](contribution_guide.md)
+    - 5.1 [Contributing](../CONTRIBUTING.md)
+    - 5.2 [Local Development](local_development.md)
+    - 5.3 [Protocol](protocol.md)
+06. [Miscelaneous](miscellaneous.md)
+    - 6.1 [History](history.md)
+    - 6.2 [Conceptual](conceptual.md)
+    - 6.3 [Main Concepts](main.md)
+    - 6.4 [Modeling Systems with Actors](modeling_with_actors.md)
+    - 6.5 [Durable Computing](durable.md)
 
 [Next: Overview](overview.md)
 
diff --git a/docs/install.md b/docs/install.md
@@ -43,6 +43,6 @@ kubectl create ns eigr-functions && curl -L https://github.com/eigr/spawn/releas
 
 [Back to Index](index.md)
 
-[Next: Getting Started](getting_started.md)
+[Next: Custom Resources](crds.md)
 
-[Previous: Features](features.md)
+[Previous: Operator Manual](operator_manual.md)
diff --git a/docs/local_development.md b/docs/local_development.md
@@ -18,6 +18,6 @@ For more information on how to collaborate or even to get to know the project st
 
 [Back to Index](index.md)
 
-[Next: Main Concepts](main.md)
+[Next: Protocol](protocol.md)
 
-[Previous: Observability](observability.md)
+[Previous: Contributing](../CONTRIBUTING.md)
diff --git a/docs/main.md b/docs/main.md
@@ -71,6 +71,6 @@ Nats' ability to natively implement different topologies, as well as its minimal
 
 [Back to Index](index.md)
 
-[Next: Durable Computing](durable.md)
+[Next: Modeling Systems with Actors](modeling_with_actors.md)
 
-[Previous: Local Development](local_development.md)
+[Previous: Conceptual](conceptual.md)
diff --git a/docs/miscellaneous.md b/docs/miscellaneous.md
@@ -0,0 +1,9 @@
+# Miscellaneous
+
+TODO
+
+[Back to Index](index.md)
+
+[Next: History](history.md)
+
+[Previous: Protocol](protocol.md)
diff --git a/docs/modeling_with_actors.md b/docs/modeling_with_actors.md
@@ -110,6 +110,6 @@ The Actor Model offers a robust paradigm for building scalable, resilient, and m
 
 [Back to Index](index.md)
 
-[Next: Index](index.md)
+[Next: Durable Computing](durable.md)
 
-[Previous: History](history.md)
+[Previous: Main Concepts](main.md)
diff --git a/docs/observability.md b/docs/observability.md
@@ -9,6 +9,6 @@ Spawn exports metrics in Prometheus format and also pushes traces in OTLP format
 
 [Back to Index](index.md)
 
-[Next: Local Development](local_development.md)
+[Next: Contribution Guilde](contribution_guide.md)
 
-[Previous: Activators](activators.md)
+[Previous: Activator Resource](crds/activator.md)
diff --git a/docs/operator_manual.md b/docs/operator_manual.md
@@ -0,0 +1,9 @@
+# Operator Manual
+
+TODO
+
+[Back to Index](index.md)
+
+[Next: Install](install.md)
+
+[Previous: Activators](activators.md)
diff --git a/docs/overview.md b/docs/overview.md
@@ -24,6 +24,6 @@ This also brings security to CEOs and CTOs as well as product managers that the
 
 [Back to Index](index.md)
 
-[Next: Architecture](architecture.md)
+[Next: Getting Started](getting_started.md)
 
 [Previous: Index](index.md)
diff --git a/docs/projections.md b/docs/projections.md
@@ -235,4 +235,10 @@ alias Inventory.InventoryProjectionActor, as: InventoryClient
 
 {:ok, %GeneralInventoryResponse{inventory: inventories} = _response} = InventoryClient.query_product(%ProductQuery{product_id: "some_id"}, metadata: %{"page" => 
 "1", "page_size" => "50"})
-```
+```
+
+[Back to Index](index.md)
+
+[Next: Features](features.md)
+
+[Previous: Actors](actors.md)
diff --git a/docs/protocol.md b/docs/protocol.md
@@ -158,6 +158,6 @@ InvocationRequest type bytes encoded here :-)
 
 [Back to Index](index.md)
 
-[Next: Contributing](../CONTRIBUTING.md)
+[Next: Miscellaneous](miscellaneous.md)
 
 [Previous: Durable Computing](durable.md)
diff --git a/docs/sdks.md b/docs/sdks.md
@@ -22,6 +22,6 @@ Full documentation for each language can be found in each of their repositories,
 
 [Jump to language support index](sdks/index.md)
 
-[Next: Custom Resources](crds.md)
+[Next: Statestores](statestores.md)
 
-[Previous: Getting Started](getting_started.md)
+[Previous: Features](features.md)
diff --git a/docs/statestores.md b/docs/statestores.md
@@ -48,4 +48,4 @@ It is also worth mentioning that this feature depends on the implementation of e
 
 [Next: Activators](activators.md)
 
-[Previous: Custom Resources](crds.md)
+[Previous: SDKs](sdks.md)

Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,4 @@ Spawn defines some custom Resources for the user to interact with the API for de`
`26`	`26`
`27`	`27`	`[Next: Actor System Resource](crds/actor_system.md)`
`28`	`28`
`29`		`-[Previous: SDKs](sdks.md)`
	`29`	`+[Previous: Install](install.md)`