Skip to content

Commit b8c1156

Browse files
committed
chore(qol): Add .context to store ephemeral, external, or temp files that LLMs can use to help with docs management. Move plans to .content/plans, untracked.
1 parent 9b438f9 commit b8c1156

File tree

5 files changed

+48
-250
lines changed

5 files changed

+48
-250
lines changed

.context/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Context Files for LLMs and AI Tools
2+
3+
This directory contains plans, reports, and other context files that are:
4+
- Used to provide context to LLMs during development
5+
- Not committed to the repository
6+
- May be transient or belong in other repositories
7+
8+
## Directory Structure
9+
10+
- `plans/` - Documentation plans and roadmaps
11+
- `reports/` - Generated reports and analyses
12+
- `research/` - Research notes and findings
13+
- `templates/` - Reusable templates for Claude interactions
14+
15+
## Usage
16+
17+
Place files here that you want to reference--for example, using @ mentions in Claude--such as:
18+
- Documentation planning documents
19+
- API migration guides
20+
- Performance reports
21+
- Architecture decisions
22+
23+
## Example Structure
24+
25+
```
26+
.context/
27+
├── plans/
28+
│ ├── v3.2-release-plan.md
29+
│ └── api-migration-guide.md
30+
├── reports/
31+
│ ├── weekly-progress-2025-07.md
32+
│ └── pr-summary-2025-06.md
33+
├── research/
34+
│ └── competitor-analysis.md
35+
└── templates/
36+
└── release-notes-template.md
37+
```
38+
39+
## Best Practices
40+
41+
1. Use descriptive filenames that indicate the content and date
42+
2. Keep files organized in appropriate subdirectories
43+
3. Consider using date prefixes for time-sensitive content (e.g., `2025-07-01-meeting-notes.md`)
44+
4. Remove outdated files periodically to keep the context relevant

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,7 @@ test-results.xml
2626
**/config.toml
2727
package-lock.json
2828
tmp
29+
30+
# Context files for LLMs and AI tools
31+
.context/*
32+
!.context/README.md

plans/README.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

plans/cli-docs-sync/execution-log.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

plans/cli-docs-sync/plan-v3.2.0.md

Lines changed: 0 additions & 165 deletions
This file was deleted.

0 commit comments

Comments
 (0)