delete sdk reference index. removed links from other indices, reforma…

…tted update timestamp and line change count for all files.
abstractoperators · Dec 4, 2024 · d9de47e · d9de47e
1 parent b934ee9
commit d9de47e
Show file tree

Hide file tree

Showing 22 changed files with 102 additions and 81 deletions.
diff --git a/scripts/update_last_edited.py b/scripts/update_last_edited.py
@@ -30,16 +30,16 @@ def update_last_edited(file_paths):
             with open(file_path, "r", encoding="utf-8") as file:
                 content = file.read()
 
-            # Replacing existing respects placement if it already exists, and adds it to the top if it doesn't.
+            # Replacing existing respects placement if it already exists, and adds it to the bottom if it doesn't.
             if lines_changed_pattern.search(content):
                 content = lines_changed_pattern.sub(lines_changed_str, content)
             else:
-                content = lines_changed_str + "\n" + content
+                content = content + "\n" + lines_changed_str
 
             if last_updated_pattern.search(content):
                 new_content = last_updated_pattern.sub(date_str, content)
             else:
-                new_content = date_str + "\n" + content
+                new_content = content + "\n" + date_str
 
             with open(file_path, "w", encoding="utf-8") as file:
                 file.write(new_content)

diff --git a/webapp/docs/config/mkdocs.yml b/webapp/docs/config/mkdocs.yml
@@ -54,7 +54,6 @@ nav:
       - Deployments:
           - developer-guide/deployments/local.md
   - SDK Guide:
-      - sdk-reference/index.md
       - sdk-reference/operators.md
       - sdk-reference/messages.md
       - sdk-reference/tools.md

diff --git a/webapp/docs/docs/developer-guide/database.md b/webapp/docs/docs/developer-guide/database.md
@@ -169,5 +169,8 @@ connection.execute(
 
 For a deeper dive, please examine the [alembic operations reference](https://alembic.sqlalchemy.org/en/latest/ops.html).
 
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +173, -0
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +5, -2
diff --git a/webapp/docs/docs/developer-guide/deployments/local.md b/webapp/docs/docs/developer-guide/deployments/local.md
@@ -1,5 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +26, -0
 # Local Deployments
 
 It's often necessary, and recommended, to deploy our services locally while making changes to them.
@@ -23,4 +21,10 @@ The auth service can be deployed locally via
 make local-auth
 ```
 
-Once the auth service is up, create a session by navigating to `auth.abop.bot:8002/login` in your choice of browser.
+Once the auth service is up, create a session by navigating to `auth.abop.bot:8002/login` in your choice of browser.
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +7, -3
diff --git a/webapp/docs/docs/developer-guide/index.md b/webapp/docs/docs/developer-guide/index.md
@@ -3,11 +3,8 @@
 Welcome to Abstract Operator's developer guide for `concrete`!
 This section will get you set up to start developing directly on the codebase, as opposed to being just a user.
 
-## [Setup](setup.md)
+---
 
-## [Deployments](deployments/local.md)
+Last Updated: 2024-12-04 09:21:32 UTC
 
-## [Database](database.md)
-
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +13, -0
+Lines Changed: +3, -6
diff --git a/webapp/docs/docs/developer-guide/setup.md b/webapp/docs/docs/developer-guide/setup.md
@@ -1,4 +1,3 @@
-
 # Setup
 
 This guide will take you through environment setup in order to run the codebase locally and contribute to our project.
@@ -169,6 +168,8 @@ By default, operators rely on OpenAI ChatGPT 4 models to process queries. OpenAI
 OPENAI_API_KEY=<your api key here>
 ```
 
-Last Updated: 2024-11-18 18:33:48 UTC
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
 
-Lines Changed: +174, -0
+Lines Changed: +4, -3
diff --git a/webapp/docs/docs/index.md b/webapp/docs/docs/index.md
@@ -2,14 +2,8 @@
 
 Concrete is an AI agent orchestration platform.
 
-## [Install](installation.md)
+---
 
-## [Learn Concepts](learn/concepts/index.md)  
+Last Updated: 2024-12-04 09:21:32 UTC
 
-## [SDK Reference](sdk-reference/index.md)
-
-## [Developer Guide](developer-guide/index.md)
-
-
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +15, -0
+Lines Changed: +3, -9
diff --git a/webapp/docs/docs/installation.md b/webapp/docs/docs/installation.md
@@ -25,5 +25,8 @@ Other extras include:
 
 [Developer Installation](developer-guide/setup.md)
 
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +29, -0
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +5, -2
diff --git a/webapp/docs/docs/learn/concepts/daemons.md b/webapp/docs/docs/learn/concepts/daemons.md
@@ -1,5 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +19, -0
 # Daemons
 
 ## GH Daemon
@@ -17,3 +15,9 @@ Loaded in from `.env.daemons` at build-time.
   - App client id.
 - GH_PRIVATE_KEY_PATH
   - Path to *.pem file relative to `webapp/daemon/server.py`.
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +6, -2
diff --git a/webapp/docs/docs/learn/concepts/index.md b/webapp/docs/docs/learn/concepts/index.md
@@ -1,5 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +21, -0
 # Key Concepts
 
 **[Operators](operators.md)**  
@@ -19,3 +17,9 @@ A `Project` represents a unit of work executed on and returned to a user or anot
 
 **Daemons**
 `Daemons` are long-running processes providing an entrypoint for Operators and Tools to interact.
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +6, -2
diff --git a/webapp/docs/docs/learn/concepts/operators.md b/webapp/docs/docs/learn/concepts/operators.md
@@ -1,6 +1,4 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +16, -0
-# Operators  
+# Operators
 
 Operators are agents with a specific prompt and a set of pre-defined interactions. They are capable of performing well-defined roles, working with other operators, and using tools.
 
@@ -13,4 +11,10 @@ from concrete import operators
 
 operator = operators.Operator()
 operator.chat("Hey there, operator!")
-```
+```
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +8, -4
diff --git a/webapp/docs/docs/learn/concepts/projects.md b/webapp/docs/docs/learn/concepts/projects.md
@@ -1,5 +1,9 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +5, -0
 # Projects
 
 A project represents a unit of work done by one or more Operators.
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +6, -2
diff --git a/webapp/docs/docs/learn/concepts/tools.md b/webapp/docs/docs/learn/concepts/tools.md
@@ -75,5 +75,9 @@ Arithmetic Tool with methods:
 ```
 
 Under the hood in `Operator.qna`, the tool is invoked and refed to the operator so it can complete the original chat prompt.
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +79, -0
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +6, -2
diff --git a/webapp/docs/docs/learn/hello-world.md b/webapp/docs/docs/learn/hello-world.md
@@ -1,7 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-
-Lines Changed: +73, -0
-
 # Hello World
 
 Let's go ahead and make our "Hello World" equivalent for `concrete`.
@@ -70,4 +66,10 @@ for operator, result in [_ async for _ in project_output]:
 
 `process_new_project` returns an `AsyncGenerator` that yields tuples of form `(operator_name, operator_output)`.
 The results will be in chronological order; that is, printing out the results like we have here lets you see the whole conversation between our executive and developer!
-Go ahead and try running the same code with different prompts; instead of `"Create a simple hello world program"`, consider "Create a basic calculator application".
+Go ahead and try running the same code with different prompts; instead of `"Create a simple hello world program"`, consider "Create a basic calculator application".
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +7, -5
diff --git a/webapp/docs/docs/learn/index.md b/webapp/docs/docs/learn/index.md
@@ -2,9 +2,8 @@
 
 This section will teach you how to make the most of `concrete`.
 
-## [Hello World](hello-world.md)
+---
 
-## [Concepts](concepts/index.md)
+Lines Changed: +3, -4
 
-Lines Changed: +10, -0
-Last Updated: 2024-11-18 18:33:48 UTC
+Last Updated: 2024-12-04 09:21:32 UTC
diff --git a/webapp/docs/docs/sdk-reference/database.md b/webapp/docs/docs/sdk-reference/database.md
@@ -70,5 +70,8 @@ with Session() as session:
     session.commit()
 ```
 
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +74, -0
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +5, -2
diff --git a/webapp/docs/docs/sdk-reference/index.md b/webapp/docs/docs/sdk-reference/index.md
diff --git a/webapp/docs/docs/sdk-reference/messages.md b/webapp/docs/docs/sdk-reference/messages.md
@@ -1,6 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +18, -0
-
 # Messages
 
 Messages are a format for structured outputs from OpenAI completions. Outputs are validated against the Message format, guaranteeing the syntax.
@@ -16,3 +13,9 @@ class CustomMessage(Message):
 ```
 
 Messages can be used in Operators by passing the `response_format` option to string returning functions. By default, the `TextMessage` format is used.
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +6, -3
diff --git a/webapp/docs/docs/sdk-reference/operators.md b/webapp/docs/docs/sdk-reference/operators.md
@@ -1,5 +1,3 @@
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +111, -0
 # Operators
 
 ## Abstract Operators
@@ -108,4 +106,10 @@ operator = Operator()
 operator.chat(
     "Could you make a directory for a helloworld python project?", options={'response_format': ProjectDirectory}
 )
-```
+```
+
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +7, -3
diff --git a/webapp/docs/docs/sdk-reference/orchestrators.md b/webapp/docs/docs/sdk-reference/orchestrators.md
@@ -23,6 +23,8 @@ Creates and processes a new software project.
 
 Returns an AsyncGenerator of the project's messages.
 
-#
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +28, -0
+---
+
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +5, -3
diff --git a/webapp/docs/docs/sdk-reference/projects.md b/webapp/docs/docs/sdk-reference/projects.md
@@ -73,6 +73,8 @@ Internal method executing the node's task with provided default kwargs and kwarg
 
 String representation of the node.
 
+---
 
-Last Updated: 2024-11-18 18:33:48 UTC
-Lines Changed: +78, -0
+Last Updated: 2024-12-04 09:21:32 UTC
+
+Lines Changed: +4, -2
diff --git a/webapp/docs/docs/sdk-reference/tools.md b/webapp/docs/docs/sdk-reference/tools.md
@@ -25,7 +25,8 @@ class Arithmetic(metaclass = MetaTool):
 print(Arithmetic)
 ```
 
+---
 
-Last Updated: 2024-11-18 18:33:48 UTC
+Last Updated: 2024-12-04 09:21:32 UTC
 
-Lines Changed: +31, -0
+Lines Changed: +3, -2