docs: add comprehensive project wiki for v1.0

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
2026-06-04 14:07:55 -06:00
parent a758e8e0bc
commit 0166fb6511
32 changed files with 1483 additions and 0 deletions
@@ -0,0 +1,52 @@
+# By the numbers
+
+Data collected on 2026-06-04.
+
+## Size
+
+| Metric | Value |
+| ------ | ----- |
+| Total source files | 12 |
+| Total lines of code | ~7,535 |
+| Largest file | `src/tunnel.rs` (3,526 lines) |
+| Second largest | `src/socks5.rs` (789 lines) |
+| Third largest | `src/framing.rs` (776 lines) |
+| Test files | 0 standalone test files (all tests are inline `#[cfg(test)]` modules) |
+| Languages | Rust only |
+
+```mermaid
+xychart-beta
+    title "Lines of code by module"
+    x-axis [tunnel, socks5, framing, tls, main, generate, redact, cli, config, connkey, errors, signal]
+    y-axis "Lines" 0 --> 3600
+    bar [3526, 789, 776, 609, 601, 440, 242, 237, 118, 93, 82, 22]
+```
+
+## Activity
+
+- **Commits:** 16 total (as of HEAD)
+- **Active development period:** June 3–4, 2026 (~2 days)
+- **Most changed file:** `src/tunnel.rs` — underwent major rewrites from per-request HTTPS to persistent multiplexed tunnel, then to binary framing, then to reconnect/shutdown handling.
+- **Second most changed:** `.github/workflows/ci.yml` — iterated on cross-platform E2E cleanup and smoke tests.
+
+## Bot-attributed commits
+
+- **Bot commits:** 7 of 16 (44%)
+- **Bot types:** `factory-droid[bot]`
+- Note: this is a lower bound. Inline AI tools like Copilot leave no trace in git history.
+
+## Complexity
+
+| File | Lines | Description |
+| ---- | ----- | ----------- |
+| `src/tunnel.rs` | 3,526 | Core tunnel engine, listener, connector, SOCKS5 proxy, reconnect loop, stream mux, ~30 inline tests |
+| `src/socks5.rs` | 789 | SOCKS5 protocol parser, greeting, auth, CONNECT, target resolution |
+| `src/framing.rs` | 776 | Binary frame serialization, deserialization, reader/writer, target encoding |
+| `src/tls.rs` | 609 | rustls config builders, certificate loading, identity validation, fingerprinting |
+| `src/main.rs` | 601 | CLI entry point, command dispatch, connection key integration, argument parsing helpers |
+
+## Dependency count
+
+- **Runtime dependencies:** 26 crates
+- **Dev dependencies:** 1 crate (`tempfile`)
+- **Largest dependency families:** Tokio ecosystem (`tokio`, `tokio-util`, `tokio-rustls`), rustls ecosystem (`rustls`, `rustls-pki-types`, `rustls-pemfile`), Hyper ecosystem (`hyper`, `hyper-util`, `http-body-util`, `tower-service`)