Open srittau opened 3 years ago
Here is how I envision the typing documentation to be structured:
User-facing basic and advanced introductions to the type system or particular aspects of it. Non-comprehensive.
Directory: /guides
/guides
User-facing guides to accomplish particular tasks.
Directory: /reference
/reference
User-facing, comprehensive reference of the type system.
Directory: /spec
/spec
Territory of the Typing Council. Targeted at type checker developers. Here be dragons. 🐉
Top level.
Additions, corrections, criticism welcome!
2014-09-02: Updated to reflect the addition of the type system spec. Also, added explanations to the categories.
Might be helpful, quick eco-system overview: https://github.com/typeddjango/awesome-python-typing/
Here is how I envision the typing documentation to be structured:
Tutorials
User-facing basic and advanced introductions to the type system or particular aspects of it. Non-comprehensive.
Howto Guides
Directory:
/guides
User-facing guides to accomplish particular tasks.
Reference
Directory:
/reference
User-facing, comprehensive reference of the type system.
Type System Specification
Directory:
/spec
Territory of the Typing Council. Targeted at type checker developers. Here be dragons. 🐉
Links
Top level.
Additions, corrections, criticism welcome!
2014-09-02: Updated to reflect the addition of the type system spec. Also, added explanations to the categories.