On Fri, 2015-03-27 at 14:30 -0400, Chuck Rolke wrote: > A. I tried the proposed site with the goal of writing a hello world from > scratch using proton. > > 1. The python documentation is very welcoming. > Nav to home -> Build AMQP applications, Qpid Proton -> Python API reference > Goes to a page that provides the highest level orientation with clear > descriptions. > > 2. The Java documentation seems well organized but I haven't tried to use it > much. > > 3. The C API is sparse. > Nav to home -> Build AMQP applications Qpid Proton -> C API reference > This dumps into Files, File List, almost like 'ls' output. Clicking on any > file shows auto-generated diagrams and file details but where's the API? The > Files pages mostly show no more comments or clues than reading the raw > sources themselves. > > [Suggestion] For the C API a better starting point would be the Modules tree. > The modules entries have more detailed descriptions and type documentation > that users need to see. > > B. The general organization is OK. Finally seeing qpid.client called out as > deprecated. > > C. Lots of links are dead. Is that an artifact of references to proton 0.9 > that doesn't exist yet? >
Thanks for the detailed review! Bad proton links are probably timing, I make sure they're all good now that 0.9 is released. I probably won't fix the C API doc this time around but your points are good. Anyone interested in volunteering? Cheers, Alan. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
