docs: README as overview, Diataxis pages under docs/ #41

Merged

mikluko merged 1 commit from docs/diataxis into main

2026-10-26 21:40:59 +00:00

mikluko commented

2026-10-26 21:39:24 +00:00

Owner

The README becomes a short overview, a quick start and links. Its other content moves to one page per Diataxis type under docs/:

how-to guides: intercepting HTTPS with a trusted CA, serving SOCKS5, rewriting headers, sending telemetry, cutting a release
reference: flags, host patterns, CA files, upstream connections, request headers, log fields, environment, exit status, SOCKS5 reply codes
explanation: tunnelling against MITM, and the proxy headers

Verified: every command was run against the built binary, a goldmark-based checker resolves every relative link and anchor, and the external links answer. The exception is pkg.go.dev, which has not yet indexed the sarak.sh module path, though the module index lists it.

The reference states one fact the old README never did: an intercepted connection does not verify the upstream server's certificate (InsecureSkipVerify in handlers.DefaultTransport).

The old TODO line "Examples" is dropped; a doc is not the place to promise. Goals and non-goals live on in the explanation page.

The README becomes a short overview, a quick start and links. Its other content moves to one page per Diataxis type under `docs/`: - how-to guides: intercepting HTTPS with a trusted CA, serving SOCKS5, rewriting headers, sending telemetry, cutting a release - reference: flags, host patterns, CA files, upstream connections, request headers, log fields, environment, exit status, SOCKS5 reply codes - explanation: tunnelling against MITM, and the proxy headers Verified: every command was run against the built binary, a goldmark-based checker resolves every relative link and anchor, and the external links answer. The exception is pkg.go.dev, which has not yet indexed the `sarak.sh` module path, though the module index lists it. The reference states one fact the old README never did: an intercepted connection does not verify the upstream server's certificate (`InsecureSkipVerify` in `handlers.DefaultTransport`). The old TODO line "Examples" is dropped; a doc is not the place to promise. Goals and non-goals live on in the explanation page.

mikluko added 1 commit

2026-10-26 21:39:24 +00:00

docs: README as overview and quick start, with Diataxis pages under docs/

CI / changelog (pull_request) Successful in 6s

Details

CI / test (pull_request) Successful in 1m11s

Details

bb004e8415

How-to guides for interception, SOCKS5, header rewriting, telemetry and
releasing; a command-line reference; and explanations of tunnelling against
MITM and of the proxy headers. Every command was run against the binary.

mikluko merged commit e54d11de80 into main

2026-10-26 21:40:59 +00:00

mikluko deleted branch docs/diataxis

2026-10-26 21:40:59 +00:00

mikluko referenced this pull request from a commit

2026-10-26 21:41:00 +00:00

Merge pull request 'docs: README as overview, Diataxis pages under docs/' (#41) from docs/diataxis into main