NEW: Better Pyramid introductory docs with the Quick Tour of Pyramid
tl;dr Well-polished introductory material for Pyramid
Pyramid has always had great docs. In fact, the docs were released before the software! The docs are comprehensive and always-updated on each of the (over 100) Pyramid (and its predecessor, BFG) releases.
However, we've known for a long time that the docs needed a casual introduction. The docs are aimed at those looking for a deep treatment. We've needed a shallow-but-wide overview that linked into the deeper explanations.
Enter the Quick Tour of Pyramid. A casual introduction to 19 topics that Python web developers want in a web framework, each with links into further material, including a deeper treatment in the new Quick Tutorial (the topic of a later post.)
We've been thinking a lot lately about introductory material for Pyramid. The Quick Tour is the product of this and has undergone several refinements since its first appearance. For example, all the code snippets are included from known-to-work Python modules on disk. We also greatly expanded the use of Intersphinx, to ensure our links to other Pyramid/Python code don't break without generating an error.
Lately we've come to view Pyramid as the "Start Small, Finish Big, Stay Finished" web framework. The software excels at this. For the "Start Small" part, we want the documentation to as well. Give it a look, and if you find a mistake or have some feedback, let us know.