|
1 | 1 | # CLAUDE.md |
2 | 2 |
|
3 | | -This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
| 3 | +## Overview |
4 | 4 |
|
5 | | -## Memory Bank Design Context |
| 5 | +The Socratic Shell documents my journey trying to build a collaborative partner that can empower me to tackle anything and everything. |
6 | 6 |
|
7 | | -@src/memory-bank/README.md |
| 7 | +The repository combines an mdbook (found in `src`) with various code experiments. A summary of everything we are doing can be found in the mdbook summary: |
8 | 8 |
|
9 | | -### Maintenance & Workflow |
10 | | -The mdBook whose table of contents lies in `src/SUMMARY.md` must be kept current as design evolves. |
11 | | -The table of contents can be useful to find sources of additional information about the memory bank design. |
| 9 | +@src/SUMMARY.md |
12 | 10 |
|
13 | | -### Checkpointing |
| 11 | +## Conventions for working in this project |
14 | 12 |
|
15 | | -When asked to "checkpoint our work", remember to take the following steps: |
16 | | -- Update [Current Design State](./src/memory-bank/current-state.md) with new insights/discoveries |
17 | | -- Move completed items from Open Questions to Key Design Decisions |
18 | | -- Document new principles discovered in the [Design Foundation](./src/memory-bank/design-foundation.md) |
19 | | -- Add new questions to cover design pivots in the [FAQ](./src/memory-bank/faq.md) |
| 13 | +When exploring new ideas, we keep most of our documentation in the mdbook, including goals, architectural design, and key implementation details. |
20 | 14 |
|
21 | | -## Dialectic testing tool |
| 15 | +However, we do not use the mdbook to store transient information like the set of ongoing tasks. Those are maintained in github issues: |
22 | 16 |
|
23 | | -@src/dialectic/README.md |
| 17 | +@src/prompts/project/github-tracking-issues.md |
24 | 18 |
|
25 | | -## Socratic Shell Conventions |
| 19 | +When writing code, we use AI insight comments to capture key insights: |
26 | 20 |
|
27 | | -@src/prompts/project/github-tracking-issues.md |
28 | 21 | @src/prompts/project/ai-insights.md |
29 | | - |
30 | | -@src/SUMMARY.md |
31 | | -(Complete architecture, implementation details, research archive) |
0 commit comments