search

IntersectMBO / ouroboros-network

Specifications of network protocols and implementations of components running these protocols which support a family of Ouroboros Consesus protocols; the diffusion layer of the Cardano Node.
https://ouroboros-network.cardano.intersectmbo.org
Apache License 2.0
275 stars 86 forks source link

[DOCS] Links to implemented mini-protocols are obsolete #2780

Open mark-stopka opened 3 years ago

mark-stopka commented 3 years ago

Links to implemented mini-protocols in The Shelley Networking Protocol (Version 1.0.0 , Revision 47 ) from October 5, 2020 are obsolete, e.q. Handshake Mini Protocol points to src/Ouroboros/Network/Protocol/Handshake/Type.hs while in reality the implementation is in ouroboros-network-framework/src/Ouroboros/Network/Protocol/Handshake.hs...

image

Same applies to most, if not all links to reference implementations, it is not the case only for the overview table where there may be some ambiquity, but also for the protocol specific sections later. In case of Handshake Mini Protocol, Section 2.10 links to https://github.com/input-output-hk/ouroboros-network/blob/master/src/Ouroboros/Network/Protocol/Handshake/Type.hs which does not even exist...

@pavlix or myself can fix those references in the documentation while implementing the rust-cardano-ouroboros-network, however we would like to know if there is any re-factoring planned of the directory / module structure for ouroboros-network so our time is not wasted in vain on updating documentation that would become obsole shortly again... considering that p2p support is underway...

coot commented 3 years ago

@mark-stopka we don't have plans at the moment to move handshake mini-protocol.

I would prefer to link to ouroboros-network-framework/src/Ouroboros/Network/Protocol/Handshake/Type.hs over ouroboros-network-framework/src/Ouroboros/Protocol/Hanshake.hs. The latter exports convenient wrappers, the former is where the protocol is defined.