readme
README Guidelines
Each top-level package directory (e.g., plain-api/) has a README.md symlink pointing to the actual README inside the package (e.g., plain-api/plain/api/README.md). Only edit the README inside the package itself.
See plain-jobs/plain/jobs/README.md as a good example.
Purpose
The README answers: "How do I use this?" It gets users productive quickly and points them to code for deeper exploration. It is not a complete API reference.
Required Structure
Every README follows this order:
More from dropseed/plain
annotations
Workflow for adding type annotations to Plain packages. Use this when adding or improving type coverage.
23release
Releases Plain packages with intelligent version suggestions and parallel release notes generation. Use when releasing packages to PyPI.
22plain-guide
Answer questions about the Plain framework by researching docs and source code. Use when asked "how do I...", "does Plain support...", or "how does X work?" questions.
1