be2da83b1b
This pull request publishes the step-by-step design document that I have been discussing with @hellais and @DecFox recently. Compared to the document that was approved, this one has been edited for readability. While there, I figured it was also be beneficial to publish the few ooni/probe-cli related design documents we produced in the past, because they probably help someone to get acquainted with the codebase. Reference issue for this pull request: https://github.com/ooni/probe/issues/2148 |
||
|---|---|---|
| .. | ||
| dd-001-oonimkall.md | ||
| dd-002-netx.md | ||
| dd-003-step-by-step.md | ||
| README.md | ||
Design documents
This directory contains ooni/probe-cli design documents. We generally use issues as short design documents, but some more-complex discussions require proper design documents. We started collecting existing design documents into this repository on 2022-06-13, to provide additional clarity regarding our more-complex choices.
Implementation aspects may change freely over time and there's no need to rush back and update the related design document. We want to keep a design document around to document the why of specific choices. Most design documents are, therefore, informational and historic by nature, given that we do not aim to continuously update them.
Rather than radically revamp a design document in case of radical direction changes, it is advisable to create a new design document referencing the previous design document and explaining what changed.