chore(ask): reorganize docs and fix repo checks
This commit is contained in:
@@ -0,0 +1,17 @@
|
||||
# Docs
|
||||
|
||||
This folder keeps only the documentation needed to understand and maintain the extension without turning docs into a second copy of the code.
|
||||
|
||||
## Files
|
||||
|
||||
- `contract.md` — external behavior, result shape, and UX guarantees
|
||||
- `architecture.md` — module boundaries and invariants
|
||||
|
||||
## Reading order
|
||||
|
||||
- start with `contract.md` for behavior
|
||||
- read `architecture.md` for code layout
|
||||
|
||||
## Rule of thumb
|
||||
|
||||
If a detail is about implementation mechanics, it should usually live in `src/` or `tests/`, not here.
|
||||
Reference in New Issue
Block a user