Rodin
31 lines
761 B
Markdown
31 lines
761 B
Markdown
# Source Notes
|
|
|
|
This directory stores the reusable evidence behind the convention docs.
|
|
|
|
## What belongs here
|
|
|
|
One note per upstream repo, with:
|
|
- why the repo was chosen
|
|
- repeated conventions, not just isolated examples
|
|
- caveats and counterexamples
|
|
- exact `file:line` anchors
|
|
- pattern candidates supported by the evidence
|
|
|
|
## Current notes
|
|
|
|
- `fastapi.md`
|
|
- `starlette.md`
|
|
- `pydantic.md`
|
|
- `httpx.md`
|
|
- `fastapi-users.md`
|
|
- `full-stack-fastapi-template.md`
|
|
|
|
## Quality bar
|
|
|
|
A source note is good when it makes later synthesis cheap:
|
|
- repeated patterns are clearly separated from one-off examples
|
|
- framework-owned caveats are preserved
|
|
- citations are fast to verify
|
|
- vague claims are trimmed away
|
|
|
|
Read `../PROCESS.md` for the full repeatable workflow. |