High level documentation providing overview of ontology
Open
- Dominant language
- Rust
- Stars
- 74
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
For developers working on tx5, it would be helpful to have some docs that give an overview of the various components and how they fit together. I believe this are all the components and their relationships:
- Endpoint
- Sig
- Hub
- set of Peer
- FramedConn
- Conn
- Webrtc
AC:
- Review components, add module-level comments to any missing them
- Add an overview module-level comment to each crate, outlining the components within it.
Contributor guide
Assessment
This issue has not been assessed yet.