docs: tighten setup and operations docs - #122
Merged
Merged
Conversation
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
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.
Note
🤖 Claude Opus 5.5 on behalf of Oliver
Explain Like I'm Lost
The last 13 PRs added a lot of how-it-works detail to
docs/user. This PR cuts those guides back to what an operator needs (prerequisites, commands, what success looks like, and common failures) and fixes stale commands and links. It does not change any code.Why
#manage-d1-migrationsanchor.vite devnow rejects.development.mdlinked to a missing#deploy-the-dashboardanchor.datasets.mdsaid the web app readsDATASETS_CONFIG_PATH. It does not.setup-pipeline.mdsaid coordinated subsets need identical locality rules. The code does not require that.uoregon) and used a real-looking path (/data/netflow/...).Fix
Reviewer fast path: skim
docs/user/setup-pipeline.md,operations.md, anddatasets.md. Those three hold most of the change. Check that no procedure you rely on is gone.pipeline-contract.md, so this PR removes them from the user guide.export+deployblock with its two common failures. Publish and rollback are merged into one section. The Cloudflare and D1 steps are shorter.pipeline-contract.mdonly.pipeline-contract.mdgets a short "Cluster launcher" subsection. It is the only architecture material moved out of the user docs.pipeline-contract.mdnow describesdaily_active_sourcesandtos_anonymizedin neutral terms, and theextract-windowexample usesdata/example.documentation.mdgets a "User documents" rule block: task-first writing and neutral placeholders.docs/agentis untouched. It contained no real hostnames.Verification
netflow-db <cmd> --helpbuild ofdd25082,scripts/netflow-db-cluster.sh --help,infra/self-hosted.ts,package.jsonscripts,apps/web/src/env.ts, and.node-version.README.md,CONTEXT.md,AGENTS.md, anddocs/**. All resolve.bun run format,bun run lint, andbun run typecheckpass.Made by Claude Opus 5.5 in Claude Code.