@@ -5,6 +5,7 @@ This document describes the architecture and workflows of the workspace.
5
5
## Overview
6
6
7
7
This workspace implements a forkable agent architecture, designed to be used as a foundation for creating new agents. For details about:
8
+
8
9
- Forking process: See [ ` knowledge/agent-forking.md ` ] ( ./knowledge/agent-forking.md )
9
10
- Workspace structure: See [ ` knowledge/forking-workspace.md ` ] ( ./knowledge/forking-workspace.md )
10
11
@@ -14,133 +15,20 @@ For a information about tools used in this workspace, see [`TOOLS.md`](./TOOLS.m
14
15
15
16
## Task System
16
17
17
- The task system is designed to help gptme-agent track and manage work effectively across sessions.
18
-
19
- ### Components
20
-
21
- 1 . [ ** ` TASKS.md ` ** ] ( ./TASKS.md )
22
- - Main task registry
23
- - Contains all tasks categorized by area
24
- - Each task has a clear status indicator
25
- - Links to task files in ` tasks/ `
26
-
27
- 2 . ** Task Files**
28
- - All task files stored in [ ` tasks/ ` ] ( ./tasks ) as single source of truth
29
- - Task state managed via symlinks in state directories:
30
- - ` tasks/new/ ` : Symlinks to new tasks
31
- - ` tasks/active/ ` : Symlinks to tasks being worked on
32
- - ` tasks/paused/ ` : Symlinks to temporarily paused tasks
33
- - ` tasks/done/ ` : Symlinks to completed tasks
34
- - ` tasks/cancelled/ ` : Symlinks to cancelled tasks
35
- - Never modify task files directly in state directories, always modify in ` tasks/ `
36
-
37
- 3 . ** Journal Entries**
38
- - Daily progress logs in [ ` journal/ ` ] ( ./journal )
39
- - Each entry documents work done on tasks
40
- - Includes reflections and next steps
41
-
42
- ### Task Lifecycle
43
-
44
- 0 . ** Retrieval**
45
- - Retrieve context needed to plan the task
46
- - Quick search:
47
- ``` sh
48
- # Find files containing term
49
- git grep -li < query>
50
-
51
- # Show matching lines
52
- git grep -i < query>
53
- ```
54
- - Detailed search with context:
55
- ` ` ` sh
56
- # Show matching lines
57
- ./scripts/search.sh " <query>"
58
-
59
- # Show with context
60
- ./scripts/search.sh " <query>" 1
61
- ` ` `
62
- - Common locations:
63
- - ` tasks/` - Task details
64
- - ` journal/` - Daily updates
65
- - ` knowledge/` - Documentation
66
-
67
- 1. ** Creation**
68
- - Create new task file in ` tasks/`
69
- - Add symlink in ` tasks/new/` : ` ln -s ../taskname.md tasks/new/`
70
- - Add to ` TASKS.md` with 🆕 status
71
-
72
- 2. ** Activation**
73
- - Move symlink from ` new/` to ` active/` : ` mv tasks/new/taskname.md tasks/active/`
74
- - Update status in ` TASKS.md` to 🏃
75
- - Create journal entry about starting task
76
-
77
- 3. ** Progress Tracking**
78
- - Daily updates in journal entries
79
- - Status updates in ` TASKS.md`
80
- - Subtask completion tracking
81
- - All edits made to file in ` tasks/`
82
-
83
- 4. ** Completion/Cancellation**
84
- - Update status in ` TASKS.md` to ✅ or ❌
85
- - Move symlink to done/ or cancelled/: ` mv tasks/active/taskname.md tasks/done/`
86
- - Final journal entry documenting outcomes
87
-
88
- 5. ** Pausing**
89
- - Move symlink from ` active/` to ` paused/` : ` mv tasks/active/taskname.md tasks/paused/`
90
- - Update status in ` TASKS.md` to ⏸️
91
- - Document progress in journal
92
-
93
- # ## Status Indicators
94
-
95
- - 🆕 NEW: Task has been created
96
- - 🏃 IN_PROGRESS: Task is being worked on
97
- - ⏸️ PAUSED: Task was temporarily paused
98
- - ✅ COMPLETED: Task has been completed
99
- - ❌ CANCELLED: Task was cancelled
18
+ The task system helps to track and manage work effectively across sessions. It consists of:
100
19
101
- # ## Best Practices
20
+ - Task files in [ ` tasks/ ` ] ( ./tasks/ ) as single source of truth
21
+ - Task management CLI in [ ` scripts/tasks.py ` ] ( ./scripts/tasks.py )
22
+ - Daily progress logs in [ ` journal/ ` ] ( ./journal/ )
102
23
103
- 1. ** File Management**
104
- - Always treat ` tasks/` as single source of truth
105
- - Never modify files directly in state directories
106
- - Use proper symlink commands for state transitions
107
- - Verify symlinks after state changes
108
-
109
- 2. ** Task Creation**
110
- - Use clear, specific titles
111
- - Break down into manageable subtasks
112
- - Include success criteria
113
- - Link related resources
114
- - Create files in ` tasks/` first, then symlink
115
-
116
- 3. ** Progress Updates**
117
- - Regular status updates in ` TASKS.md`
118
- - Document blockers/issues
119
- - Track dependencies
120
- - All edits made to files in ` tasks/`
121
-
122
- 4. ** Documentation**
123
- - Cross-reference related tasks using paths relative to repository root
124
- - Document decisions and rationale
125
- - Link to relevant documents and resources
126
- - Update knowledge base as needed
127
-
128
- 5. ** Linking**
129
- - Always link to referenced resources (tasks, knowledge, URLs)
130
- - Use relative paths from repository root when possible
131
- - Common links to include:
132
- - Tasks mentioned in journal entries
133
- - Related tasks in task descriptions
134
- - People mentioned in any document
135
- - Projects being discussed
136
- - Knowledge base articles
137
- - Use descriptive link text that makes sense out of context
24
+ See [ ` TASKS.md ` ] ( ./TASKS.md ) for more details on the task system.
138
25
139
26
## Journal System
140
27
141
28
The journal system provides a daily log of activities, thoughts, and progress.
142
29
143
30
### Structure
31
+
144
32
- One file per day: ` YYYY-MM-DD.md `
145
33
- Located in [ ` journal/ ` ] ( ./journal ) directory
146
34
- Entries are to be appended, not overwritten
@@ -156,6 +44,7 @@ The journal system provides a daily log of activities, thoughts, and progress.
156
44
The knowledge base stores long-term information and documentation.
157
45
158
46
### Structure
47
+
159
48
- Located in [ ` knowledge/ ` ] ( ./knowledge )
160
49
- Organized by topic/domain
161
50
- Includes:
@@ -166,9 +55,10 @@ The knowledge base stores long-term information and documentation.
166
55
167
56
## People Directory
168
57
169
- The people directory stores information about individuals gptme- agent interacts with.
58
+ The people directory stores information about individuals the agent interacts with.
170
59
171
60
### Structure
61
+
172
62
- Located in [ ` people/ ` ] ( ./people )
173
63
- Contains:
174
64
- Individual profiles in Markdown format
@@ -183,12 +73,15 @@ The people directory stores information about individuals gptme-agent interacts
183
73
- TODOs and action items
184
74
185
75
### Best Practices
76
+
186
77
1 . ** Privacy**
78
+
187
79
- Respect privacy preferences
188
80
- Only include publicly available information
189
81
- Maintain appropriate level of detail
190
82
191
83
2 . ** Updates**
84
+
192
85
- Keep interaction history current
193
86
- Update project collaborations
194
87
- Maintain active TODO lists
0 commit comments