Document Structure and Wishlist

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.

• Typing tutorial – from the ground up (#891)
• Type stub tutorial – writing a type stub for an existing library, stubgen, contributing to typeshed

Howto Guides

Directory: /guides

User-facing guides to accomplish particular tasks.

• How to add typing to an existing code base
• How to annotate a library (#905)

Reference

Directory: /reference

User-facing, comprehensive reference of the type system.

• Link to the typing module documentation
  • Probably needs a review
• #851
• Type stub syntax and supported constructs
• Type stub style guide

Type System Specification

Directory: /spec

Territory of the Typing Council. Targeted at type checker developers. Here be dragons. 🐉

Links

Top level.

• Links to all typing-related PEPs
• Links to type checkers and other typing tools

Additions, corrections, criticism welcome!

2014-09-02: Updated to reflect the addition of the type system spec. Also, added explanations to the categories.

Review the proposed Tutorials, /guides, /reference, /spec, and top-level Links sections, along with linked issues #891, #905, and #851. Determine which documentation work remains and split the broad wishlist into specific, actionable tasks; completion is not defined for the current issue.