Skip to content

Commit 6e58a7f

Browse files
committed
Merge branch 'master' into dev
2 parents 9f3cd41 + 1aaddf3 commit 6e58a7f

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Project Documentation Location Rule
2+
3+
When the user mentions project documentation, read from the `.monkeycode/` directory within the project.
4+
5+
## Directory Structure
6+
7+
- `.monkeycode/docs/` - Project documentation
8+
- `.monkeycode/specs/*/` - Historical feature specifications, each subdirectory contains:
9+
- `requirements.md` - Requirements document
10+
- `design.md` - Design document
11+
- `tasklist.md` - Implementation task list
12+
13+
## Guidelines
14+
15+
### Reading Project Documentation
16+
17+
When the user asks about project documentation, read files from `.monkeycode/docs/`.
18+
19+
### Finding Specific Feature Specifications
20+
21+
When the user mentions a specific feature or requirement:
22+
23+
1. List subdirectories under `.monkeycode/specs/`
24+
2. Find the subdirectory that best matches the user's description
25+
3. **Confirm with the user** whether the selected directory is correct before proceeding
26+
4. After confirmation, read the relevant files (`requirements.md`, `design.md`, `tasklist.md`) and execute the user's requested task
27+
28+
### Confirmation Example
29+
30+
As you think `.monkeycode/specs/2006-01-02-feature-xxx` maybe the most likely spec folder,
31+
32+
1. Read existing markdown files in the folder
33+
2. Compose a summary of the spec in one line
34+
3. Confirm with the user in the following style.
35+
36+
```
37+
Found the following specification directories that may match your request:
38+
- `2006-01-02-feature-xxx`: Spec Summary
39+
40+
Is this the correct feature specification? Please confirm before I proceed.
41+
```

0 commit comments

Comments
 (0)