From 28585fbdc2233aba334591509baed1e42a93af70 Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Fri, 17 Jun 2022 11:02:54 +0200 Subject: [PATCH] doc: mention step-by-step design document This commit changes the README of `./internal` to make sure we're referring to the step-by-step design doc. --- internal/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/internal/README.md b/internal/README.md index b0c0a06..0549ee5 100644 --- a/internal/README.md +++ b/internal/README.md @@ -41,12 +41,17 @@ to bootstrap OONI probe and perform measurements; We originally implemented these functionality into a separate repository: [ooni/netx](https://github.com/ooni/netx). The -original [design document](https://github.com/ooni/netx/blob/master/DESIGN.md) +original [design document](../docs/design/dd-002-netx.md) still provides a good overview of the problems we wanted to solve. +The newer [dd-002-step-by-step.md](../docs/design/dd-003-step-by-step.md) +design document describes the current architecture (as of 2022-06-17) +and the future trajectory for `netx`. -The general idea was to provide interfaces replacing standard library -objects that we could further wrap to perform network measurements without -deviating from the normal APIs expected by Go programmers. For example, +The general idea of `netx` has always been to provide interfaces replacing +standard library objects that we could further wrap to perform network +measurements without deviating from the normal APIs expected by Go programmers. + +For example, ```Go type Dialer interface { @@ -106,3 +111,4 @@ and inside `netxlite` or other packages. We are currently experimenting with step-by-step measurements, an alternative measurement approach where we break down operations in simpler building blocks. This alternative approach may eventually make `netx` obsolete. +