Hi Chris. Off the top of my head, from when I was working on a Pyramid app ~ a month ago:
- No clear visual distinction between links to glossary terms and links to further documentation. I like the glossary, but always ended up there without wanting to.
- I did find the tutorials, no issue there. (Only that the paster templates are a bit awkwardly named, but that's not a doc issue.)
- Especially the former BFG stuff, I'm thinking specifically about traversal, is explained in a way that probably makes a ton of sense to Zopeheads, but, at the time anyway, read more like a PhD thesis than like documentation.
- Again not strictly a documentation issue, but the fact that you can configure and use Pyramid in a ton of different ways means there's no straight path from getting started to actually getting something up and running, even with the tutorials. Not being opinionated about anything simply makes it very difficult to write good, forceful docs.
- No clear visual distinction between links to glossary terms and links to further documentation. I like the glossary, but always ended up there without wanting to.
- I did find the tutorials, no issue there. (Only that the paster templates are a bit awkwardly named, but that's not a doc issue.)
- Especially the former BFG stuff, I'm thinking specifically about traversal, is explained in a way that probably makes a ton of sense to Zopeheads, but, at the time anyway, read more like a PhD thesis than like documentation.
- Again not strictly a documentation issue, but the fact that you can configure and use Pyramid in a ton of different ways means there's no straight path from getting started to actually getting something up and running, even with the tutorials. Not being opinionated about anything simply makes it very difficult to write good, forceful docs.