alex-rufous commented on issue #36: QPID-8361: [Broker-J] Create a developer guide for Qpid Broker-J URL: https://github.com/apache/qpid-broker-j/pull/36#issuecomment-532226526 Tomas, Thanks a lot for the review comments. I committed a second patch for the pull request addressing majority of your comments. > Reading would be easier if there will be table of contents for larger documents like High Level Architecture. Unfortunately MD format does not support TOC naturally, so maintaining would be more difficult. I think it is worth it, because chapters do not change too much. > I generated TOC using markdown-toc utility. The TOCs can be regenerated with the script "toc-generator.sh" if required. I think it should be OK for now. > I suggest to improve High Level Architecture with > > * exchange architecture I added some basic exchange overview. I am not sure that it will be useful. I think that every section in architecture document requires writing an extra chapter with details. > * transaction architecture I will add this separately. > > * AMQP protocol error handling architecture AMQP protocol error handling requires improvements. I think writing it right now will generate more work for future. > > I submitted review comments mostly for typos I noticed during reading the guide. I hope I addressed the majority of them.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
