From 087564264e92ae964634eace588c6f160b229986 Mon Sep 17 00:00:00 2001
From: zachary62 <zhuang333@wisc.edu>
Date: Thu, 20 Feb 2025 18:40:27 -0500
Subject: [PATCH] rename details to utility

---
 docs/guide.md       | 12 ++++++------
 docs/index.md       |  4 +---
 docs/llm.md         |  2 +-
 docs/preparation.md |  2 +-
 docs/tool.md        |  2 +-
 docs/viz.md         |  2 +-
 6 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/docs/guide.md b/docs/guide.md
index e3eceae..227a36c 100644
--- a/docs/guide.md
+++ b/docs/guide.md
@@ -105,8 +105,11 @@ def test_call_llm():
    - Implement these functions and write basic tests to confirm they work correctly.
 
 3. **Flow Design**  
-   - Develop a high-level process flow that meets the project’s requirements.  
-   - Specify which utility functions are used at each step.  
+   - Develop a high-level process flow of nodes that meets the project’s requirements.  
+   - For each node in your flow:
+     - **prep**: Determine how data is accessed or retrieved.  
+     - **exec**: Outline the utility function to be used. Ideally, one utility function per node. Highlight the `utility function` name.
+     - **post**: Handle any final updates or data persistence tasks.
    - Identify possible decision points for *Node Actions* and data-intensive operations for *Batch* tasks.  
    - Illustrate the flow with a Mermaid diagram.
 
@@ -115,11 +118,8 @@ def test_call_llm():
    - Define data schemas or models that detail how information is stored, accessed, and updated.
 
 5. **Implementation**  
+   - For each node, implement the `prep`, `exec`, and `post` functions based on the flow design.
    - Start coding with a simple, direct approach (avoid over-engineering at first).  
-   - For each node in your flow:
-     - **prep**: Determine how data is accessed or retrieved.  
-     - **exec**: Outline the actual processing or logic needed.  
-     - **post**: Handle any final updates or data persistence tasks.
 
 6. **Optimization**  
    - **Prompt Engineering**: Use clear and specific instructions with illustrative examples to reduce ambiguity.  
diff --git a/docs/index.md b/docs/index.md
index a425c46..fa2986e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -44,9 +44,7 @@ We model the LLM workflow as a **Nested Directed Graph**:
 - [Viz and Debug](./viz.md)
 - Chunking
 
-> We do not provide built-in implementations. 
->
-> Example implementations are provided as reference.
+> We do not provide built-in utility functions. Example implementations are provided as reference.
 {: .warning }
 
 
diff --git a/docs/llm.md b/docs/llm.md
index eb0bfb5..7ab4d97 100644
--- a/docs/llm.md
+++ b/docs/llm.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: "LLM Wrapper"
-parent: "Details"
+parent: "Utility"
 nav_order: 1
 ---
 
diff --git a/docs/preparation.md b/docs/preparation.md
index 6e1c0fe..4fe5f00 100644
--- a/docs/preparation.md
+++ b/docs/preparation.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: "Details"
+title: "Utility"
 nav_order: 3
 has_children: true
 ---
\ No newline at end of file
diff --git a/docs/tool.md b/docs/tool.md
index ecc8e13..818ebec 100644
--- a/docs/tool.md
+++ b/docs/tool.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: "Tool"
-parent: "Details"
+parent: "Utility"
 nav_order: 2
 ---
 
diff --git a/docs/viz.md b/docs/viz.md
index cde1494..35ef076 100644
--- a/docs/viz.md
+++ b/docs/viz.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: "Viz and Debug"
-parent: "Details"
+parent: "Utility"
 nav_order: 3
 ---