Merge pull request #278 from PrefectHQ/docs

Icons update
PrefectHQ · Sep 4, 2024 · b7b7338 · b7b7338
2 parents 470f24b + d2ce0e1
commit b7b7338
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 94 deletions.
diff --git a/docs/concepts/agents/creating-agents.mdx b/docs/concepts/agents/creating-agents.mdx
@@ -6,7 +6,7 @@ Agents are a key concept in ControlFlow, representing the AI entities responsibl
 
 ## Creating agents
 
-To create an agent, use the `Agent` class. The minimal agent requires only a name:
+To create an agent, use the `Agent` class.
 
 ```python
 import controlflow as cf

diff --git a/docs/guides/default-agent.mdx b/docs/guides/default-agent.mdx
@@ -1,5 +1,6 @@
 ---
-title: Configuring Default Agents
+title: Configuring the Default Agent
+icon: robot
 ---
 
 ControlFlow uses a default agent when no specific agents are assigned to a task. Understanding how to configure and override this default agent at different levels can help you create more flexible and customized workflows.

diff --git a/docs/guides/llms.mdx b/docs/guides/llms.mdx
@@ -1,5 +1,6 @@
 ---
 title: Configuring LLMs
+icon: gear
 ---
 
 ControlFlow is optimized for workflows that are composed of multiple tasks, each of which can be completed by a different agent. One benefit of this approach is that you can use a different LLM for each task, or even for each agent assigned to a task. 

diff --git a/docs/mint.json b/docs/mint.json
@@ -77,7 +77,7 @@
             "group": "Patterns",
             "pages": [
                 "patterns/tools",
-                "patterns/user-input",
+                "patterns/interactivity",
                 "patterns/dependencies",
                 "patterns/subtasks",
                 "patterns/planning",
@@ -94,12 +94,6 @@
                 "guides/orchestration"
             ]
         },
-        {
-            "group": "Reference",
-            "pages": [
-                "reference/task-class"
-            ]
-        },
         {
             "group": "Library",
             "pages": [

diff --git a/docs/patterns/dependencies.mdx b/docs/patterns/dependencies.mdx
@@ -1,5 +1,6 @@
 ---
 title: Dependencies
+icon: link
 ---
 <Tip>
 Manage task dependencies to create complex, multi-step workflows.

diff --git a/docs/patterns/user-input.mdx → docs/patterns/interactivity.mdx b/docs/patterns/user-input.mdx → docs/patterns/interactivity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Interactivity
+icon: comments
 ---
 
 <Tip>

diff --git a/docs/patterns/subtasks.mdx b/docs/patterns/subtasks.mdx
@@ -1,5 +1,6 @@
 ---
 title: Subtasks
+icon: sitemap
 ---
 
 <Tip>

diff --git a/docs/patterns/tools.mdx b/docs/patterns/tools.mdx
@@ -1,5 +1,6 @@
 ---
 title: Tools
+icon: toolbox
 ---
 
 <Tip>

diff --git a/docs/reference/task-class.mdx b/docs/reference/task-class.mdx