Initial extracted documentation set
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
# Source Notes
|
||||
|
||||
This directory stores the reusable evidence behind the pattern docs.
|
||||
|
||||
## What belongs here
|
||||
|
||||
One note per upstream repo, with:
|
||||
- why the repo is useful
|
||||
- repeated patterns, not a reading diary
|
||||
- caveats and counterexamples
|
||||
- exact `file:line` anchors
|
||||
- pattern candidates supported by the evidence
|
||||
|
||||
## Current notes
|
||||
|
||||
- `cpython.md`
|
||||
- `httpx.md`
|
||||
- `pytest.md`
|
||||
- `pydantic.md`
|
||||
- `attrs.md`
|
||||
- `click.md`
|
||||
- `sqlalchemy.md`
|
||||
|
||||
## Quality bar
|
||||
|
||||
A source note is good when it makes later synthesis cheap:
|
||||
- repeated evidence is separated from one-off examples
|
||||
- vague claims are avoided
|
||||
- citations are fast to verify
|
||||
- caveats survive instead of being flattened away
|
||||
|
||||
Read `../PROCESS.md` for the full repeatable workflow.
|
||||
Reference in New Issue
Block a user