docs: simplify deployment docs and trim contributing duplication#213
Merged
Conversation
Cut deployment.md from 170 to 91 lines: dropped observability sections (already in AGENTS.md), merged duplicate env-var sections, trimmed staging one-time setup. Cut CONTRIBUTING.md from 104 to 52 lines by removing sections that restated pre-pr.sh / the README scripts table. Extracted the inline staging first-start migration into scripts/migrate-staging.sh.
Reader-friendliness pass: link Watchtower, Caddy, GHCR, DigitalOcean, Cloudflare, Vitest, Prettier, ESLint, Passport.js, Winston, AsyncLocalStorage, and the rest on first mention so newcomers can follow up without searching.
Five scripts had no description: install-hooks.sh, migrate.sh, migrate-staging.sh, pre-pr.sh, and the pre-commit hook itself. Each now opens with a short comment explaining what it does and when to run it.
cdtinney
force-pushed
the
cdtinney/simplify-docs
branch
from
a4f6cf7 to
c1ee1f2
Compare
Add a brevity note to the PR template — no one reads 500+ character descriptions, and most of the bulk is restating the diff.
cdtinney
force-pushed
the
cdtinney/simplify-docs
branch
from
c1ee1f2 to
0ebd475
Compare
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.
Summary
Trim docs duplication, link tools/services on first mention, and give every script a short "what + when" header.
docs/deployment.md170 → 92 lines (dropped sections already covered in AGENTS.md, merged duplicate env-var notes)CONTRIBUTING.md104 → 52 lines (removed sections that restated the README + pre-pr.sh)scripts/migrate-staging.sh; new template note asking PR authors to keep descriptions shortTesting
raw.githubusercontent.com/.../scripts/...shURLs againstscripts/