docs: rewrite the operator docs in a personal voice - #40
Merged
Conversation
Rewrite deploy, multi-node, caddy, predictor, troubleshooting, release, and the examples README so they read like a person wrote them, scan cleanly, and keep every command/flag/config key. Reflect current behavior: the quiet installer, 0.5.0, the uv-upgrade workflow, and the adopt commands. All technical content preserved or expanded; verified against src/berth and the workflow/script files. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to the README rewrite (#39). Rewrites the rest of the prose docs so they read like a person wrote them, scan cleanly, and keep everything technical.
Rewritten:
deploy.md,multi-node.md,caddy.md,predictor.md,troubleshooting.md,release.md, andexamples/README.md.**Term** —bullet lists, none of the buzzword set).uv lock --upgradeworkflow (Dependabot no longer does Python), and theberth agent adoptcommands. A couple of agents caught and fixed real config drift (the Caddyfile/HAProxy blocks now match whatsetup-leader-vps.shwrites).src/berth/and the workflow/script files; all internal links and anchors resolve.Left as-is:
docs/upgrade-0.4.md(historical 0.3→0.4 migration) anddocs/dashboards/berth.json(Grafana data).Doc-only change.
🤖 Generated with Claude Code