docs(rumqttd/architecture): added ontology description and feature description#635
docs(rumqttd/architecture): added ontology description and feature description#635anirudhRowjee merged 4 commits intomainfrom
Conversation
…scription Enhanced the description of the current architecture of `rumqttd`
swanandx
left a comment
There was a problem hiding this comment.
Great PR! Everything is explained quite nicely. 💯
|
Also wdyt about adding diagrams? All this much info can be very hard to keep in mind. Adding diagrams might help to understand it quickly. Doesn't have to be fancy just something that can describe how things link together. for e.g. below diagram shows relation between
|
|
I'd like to add Diagrams. This one you've mentioned can be one, A few other ones I can think of right now are
|
I was going to suggest something like a state transaction diagram & sequence diagram, but it will get covered by the flow of a packet. So imo diagrams you mentioned should be good enough. I think we can merge this PR and add diagrams later. That way, others can start referring to these cool docs, wdyt @henil ? |
h3nill
left a comment
There was a problem hiding this comment.
LGTM, feel free to merge if open comments are resolved.
|
All open comments have been resolved! |
…scription (bytebeamio#635) * docs(rumqttd/architecture): added ontology description and feature description Enhanced the description of the current architecture of `rumqttd` * docs(rumqttd/architecture): made docs more specific * docs(rumqttd/architecture) clarified router start semantics * docs(rumqttd/architecture): clarified link specifics and datapath
Enhanced the description of the current architecture of
rumqttdType of change
Miscellaneous (related to maintanance)
Checklist:
cargo fmtCHANGELOG.mdif its relevant of user of the library. If its not relevant mention why.This isn't relevant as it's a documentation change.