docs: fix doc drift (deploy scripts, env vars, stale CHANGELOG)#42
Merged
docs: fix doc drift (deploy scripts, env vars, stale CHANGELOG)#42
Conversation
…s, stale changelog) ## Why Wave-1 Junior dev and Documentation reviewer agents (`docs/agent-fleet/bugs.md` Bugs #17, #18, #32) flagged three doc-vs-code drifts that mislead new operators on first contact: - README.md and DEVELOPMENT.md advertise four `npm run deploy:*` scripts that don't exist in `package.json` — every recipe fails immediately with `npm ERR! missing script`. - GITHUB_APP_SETUP.md still uses the legacy env var names (`GITHUB_APP_ID`/`GITHUB_PRIVATE_KEY`/`GITHUB_WEBHOOK_SECRET`); the canonical names (`APP_ID`/`PRIVATE_KEY`/`WEBHOOK_SECRET`) live in `.env.example`. Devs copy whichever they read last and break their setup. - CHANGELOG.md "Migration Guide" tells users to install `probot@^12.0.0` and `@octokit/rest@^19.0.0`. The repo ships v14 / v22. (Bug #31 — CONTRIBUTING.md link to CODE_OF_CONDUCT.md — was a false positive: the file exists at repo root.) ## What - README.md "## Deployment" rewritten to reflect what actually exists (`docker:build` + a PM2 + Netcup VPS section that matches reality). - DEVELOPMENT.md "## npm Scripts" table aligned with `package.json` (added `setup`, dropped four fictional `deploy:*` entries). - GITHUB_APP_SETUP.md: every legacy env var name replaced with the canonical one. (Three `replace_all` sweeps.) - CHANGELOG.md "Migration Guide" replaced with a short note explaining current versions; the inaccurate v12/v19 instructions are gone. Future migration blocks will be added at release time, not pre-emptively. - CONTRIBUTING.md: dropped the hard-coded "453 tests" magic number. ## Source Wave-1 Junior dev (Bug #17, #18) and Documentation reviewer (Bug #17, #18, #32). ## Test plan - [x] 806 tests pass (no source changes) - [x] eslint clean ## Risk & rollout - Risk: trivial. Docs-only. - Rollout: self-update on merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.7 (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.
Fixes Bugs #17, #18, #32 from
docs/agent-fleet/bugs.md(wave-1 Junior dev + Documentation reviewer).npm run deploy:*scripts; replace with what actually exists.GITHUB_*legacy env var names → canonicalAPP_ID/PRIVATE_KEY/WEBHOOK_SECRET.453 testsmagic number.(Bug #31 was a false positive —
CODE_OF_CONDUCT.mdactually exists.)🤖 Generated with Claude Code