Merge pull request #16 from botanu-ai/developer-deborah

docs: use generic LF-style examples throughout documentation

Author: deborahjacob-botanu

README.md

@@ -16,12 +16,12 @@ Botanu adds **runs** on top of distributed tracing. A run represents a single bu
 ```python
 from botanu import enable, botanu_use_case
 
-enable(service_name="my-app")
+enable(service_name="my-service")
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
-    result = llm.analyze(order)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
+    result = llm.complete(...)
     return result
 ```
 

docs/api/decorators.md

@@ -29,10 +29,10 @@ from botanu import botanu_use_case
 ```python
 from botanu import botanu_use_case
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
-    result = llm.analyze(order)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
+    result = llm.complete(...)
     return result
 ```
 
@@ -53,9 +53,9 @@ def process_order(order_id: str):
 ```python
 from botanu import use_case
 
-@use_case(name="process_order")
-def process_order(order_id: str):
-    return db.get_order(order_id)
+@use_case(name="my_workflow")
+def my_function():
+    return db.query(...)
 ```
 
 ## @botanu_outcome
@@ -79,19 +79,18 @@ def extract_data():
 ```python
 from botanu import botanu_use_case, botanu_outcome
 
-@botanu_use_case(name="data_pipeline")
-def run_pipeline():
-    extract_data()
-    transform_data()
-    load_data()
+@botanu_use_case(name="my_workflow")
+def my_function():
+    step_one()
+    step_two()
 
 @botanu_outcome()
-def extract_data():
-    return fetch_from_source()
+def step_one():
+    return do_work()
 
 @botanu_outcome()
-def transform_data():
-    return apply_transformations()
+def step_two():
+    return do_more_work()
 ```
 
 ## See Also

docs/getting-started/quickstart.md

@@ -26,10 +26,10 @@ enable(service_name="my-service")
 ```python
 from botanu import botanu_use_case
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
-    result = llm.analyze(order)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
+    result = llm.complete(...)
     return result
 ```
 
@@ -40,16 +40,15 @@ All LLM calls, database queries, and HTTP requests inside the function are autom
 ```python
 from botanu import enable, botanu_use_case
 
-enable(service_name="order-service")
+enable(service_name="my-service")
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
     result = openai.chat.completions.create(
         model="gpt-4",
-        messages=[{"role": "user", "content": order.description}]
+        messages=[{"role": "user", "content": data}]
     )
-    db.save_result(order_id, result)
     return result
 ```
 
@@ -58,7 +57,7 @@ def process_order(order_id: str):
 | Attribute | Example | Description |
 |-----------|---------|-------------|
 | `botanu.run_id` | `019abc12-...` | Unique run identifier |
-| `botanu.use_case` | `process_order` | Business use case |
+| `botanu.use_case` | `my_workflow` | Business use case |
 | `gen_ai.usage.input_tokens` | `150` | LLM input tokens |
 | `gen_ai.usage.output_tokens` | `200` | LLM output tokens |
 | `db.system` | `postgresql` | Database system |

docs/index.md

@@ -51,12 +51,12 @@ Botanu introduces **run-level attribution**: a unique `run_id` that follows your
 ```python
 from botanu import enable, botanu_use_case
 
-enable(service_name="my-app")
+enable(service_name="my-service")
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
-    result = llm.analyze(order)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
+    result = llm.complete(...)
     return result
 ```
 

docs/integration/auto-instrumentation.md

@@ -15,12 +15,12 @@ from botanu import enable, botanu_use_case
 
 enable(service_name="my-service")
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
     result = openai.chat.completions.create(
         model="gpt-4",
-        messages=[{"role": "user", "content": order.description}]
+        messages=[{"role": "user", "content": data}]
     )
     return result
 ```

docs/integration/kubernetes.md

@@ -253,11 +253,11 @@ from botanu import enable, botanu_use_case
 
 enable(service_name="entry-service")
 
-@botanu_use_case(name="process_order")
-def process_order(order_id: str):
-    order = db.get_order(order_id)
-    result = llm.analyze(order)
-    notify_service.send(result)
+@botanu_use_case(name="my_workflow")
+def my_function():
+    data = db.query(...)
+    result = llm.complete(...)
+    downstream_service.call(result)
     return result
 ```