System level documentation
Description
Describes broadly the structure of dragoonfly as well as the utilities we made (such as the CLI).
Detailed list of changes
Explains:
- Global structure
- What happens inside a node when a command is issued
- Quickly explains interaction with other nodes
- The API / http interface
- The CLI
Related issues
This MR will:
- close #8 (closed)
- close #9 (closed)
- close #12 (closed)
Edited by DISSOUBRAY Nathan
Merge request reports
Activity
requested review from @j.detchart
added 1 commit
- db142e86 - Change CI so it works (was changed in another branch but it was not merged yet)
- Resolved by PERENNOU Tanguy
A lot of details must be addressed to make the documentation more accessible.
Also, make a link to API.md upon citation in DOCUMENTATION.md
- Last reply by DISSOUBRAY Nathan
assigned to @n.dissoubray
- Resolved by PERENNOU Tanguy
It would be useful to document the directory structure for a given node, including the case where several nodes are on the same host. This documentation should at least feature peer IDs, file hashes and block hashes.
Also, consider using as few as possible terms. For instance, stick to encode and decode, and replace reconstruct/reconstruction.
Edited by PERENNOU Tanguy - Last reply by DISSOUBRAY Nathan
Please register or sign in to reply