move to a seperate docs directory
This commit is contained in:
10
README.md
10
README.md
@@ -27,11 +27,11 @@ Stack and commands. What technologies and what commands does the AI need to know
|
||||
|
||||
- .aider.conf.yml - Aider config (models, auto-test..)
|
||||
- .gitignore - Common stuff easy to forget.
|
||||
- SPEC.md - What the project does
|
||||
- ARCH.md - How it's built
|
||||
- CONVENTIONS.md - Code style rules
|
||||
- TESTS.md - Test cases in natural language
|
||||
- JOURNAL.md - Personal session notes
|
||||
- docs/SPEC.md - What the project does
|
||||
- docs/ARCH.md - How it's built
|
||||
- docs/CONVENTIONS.md - Code style rules
|
||||
- docs/TESTS.md - Test cases in natural language
|
||||
- docs/JOURNAL.md - Personal session notes
|
||||
|
||||
## Philosophy
|
||||
|
||||
|
||||
@@ -21,6 +21,7 @@ Example:
|
||||
|
||||
## File structure
|
||||
|
||||
Example:
|
||||
src/
|
||||
main.py
|
||||
config.py
|
||||
@@ -34,7 +35,6 @@ tests/
|
||||
One section per non-obvious decision. What we choose, what we rejected, why.
|
||||
|
||||
Example:
|
||||
|
||||
### Polling vs events
|
||||
- Decision: Polling every 10s
|
||||
- Options: Using interrupts
|
||||
Reference in New Issue
Block a user