docs: add eight how-to guides + style-guide compliance sweep#50
Conversation
📦 Previous Review (superseded by newer review)Claude finished @andybons's task in 4m 21s —— View job Review complete
SummaryThis PR touches no Go source — all 29 changed files are documentation (
I also checked every internal Markdown link and anchor fragment across the eight new guides ( The style-guide sweep (106 headings, No findings. I did not identify any factual inaccuracy, broken reference, or security-guidance gap in the new content — the load-balancer and container guides both correctly warn about |
…ompliance New task-oriented guides (11-18) for features that had only reference coverage: TCP load balancer / PROXY protocol deployment, running the container image, Postgres data plane with Neon, host command credentials, GCP service account tokens, MCP relay setup, the credential lifecycle, and Keep policy scopes. Every YAML snippet is parse-checked through gatekeeper.LoadConfig, Go snippets compile-checked, and the container guide was exercised live against the published image. Also runs the style-guide compliance sweep nobody had run: 106 headings across 18 existing pages converted from Title Case to sentence case to match getting-started/ and reference/, plus scattered terminology fixes.
|
Claude finished @andybons's task in 2m 7s —— View job Reviewing PR #50
SummaryThis PR is docs-only (
Every numeric/behavioral claim I checked matches the implementation exactly, including the more subtle ones (jitter-after-cap producing ~75s not a strict 60s ceiling, I also sampled two of the style-sweep diffs ( No findings. Nothing to flag from this pass — the guides' technical claims and the style sweep both hold up against the current codebase. |
What
Closes the "guides worth writing" gaps from the documentation audit and runs the style-compliance sweep nobody had run.
Eight new task-oriented guides (docs/content/guides/11–18), each verified against code — every YAML snippet parse-checked through
gatekeeper.LoadConfig, Go snippets compile-checked, and the container guide exercised live against the published0.17.0image:proxyHeader: PROXY_V1backend config, gatekeeper-first rollout ordering, client-IP-forgery caveatshost=/hostaddr=split for local testing without DNSop read) andpassexamplesgatekeeper.yamlsurface; Go-library path viaRunContextData, compile-checkedhttp/mcp-<server>/llm-gateway, including thatmcp-*denials set noX-Moat-Blockedheader unlike the other twoStyle-guide compliance sweep:
concepts/andguides/01–10used Title Case headings whilegetting-started/andreference/were sentence case perdocs/STYLE-GUIDE.md. 106 headings across 18 files converted, plus 4 terminology fixes (backend→source, SAN abbreviation order, two hedging removals). Behavior-neutral — no code, YAML, or link targets changed. New guides harmonized to the same conventions.docs/README.md index updated; CHANGELOG v0.17.2 Added/Changed entry.
Review
Opus-reviewed: every high-risk guide claim spot-checked against code (the
SetMCPServerssignature, the jitter-after-cap math, theX-Moat-Blockedand gzip asymmetries, the distroless base image), the sweep confirmed behavior-neutral hunk-by-hunk, and one cross-guide contradiction on gcp-service-account key rotation was caught and fixed.