docs(deployment): close end-to-end gaps + scrub AI-isms - #62
Merged
Conversation
Two changes in one pass.
Completeness:
1. Step 3a (tofu): full terraform.tfvars.tpl template inline with
op:// references for every required variable, plus the `op inject`
render command. Reader no longer has to open the example file
in another tab and guess which lines to fill.
2. Step 3b (manual): full compose/.env.tpl and api.prod.env.tpl
templates inline. Previously the page said "edit .env.production
with op:// refs" without showing what one looks like, and
referenced an .env.production file that doesn't actually exist
in the repo (the real files are compose/.env and api.prod.env).
3. Rollback: explicit `gh run list --workflow=apps-api-release.yml`
example for finding the previous SHA, plus the GHCR pkgs URL
fallback.
4. Verify section: per-check failure-mode paragraph for each of
the three curls. Operator hits a 525 or a Cloudflare-issued
cert and now knows exactly which container logs to read.
5. Post-deploy chores: each bullet has concrete steps inline (or a
specific runbook anchor that already has them), not a topic-page
link that itself is a tour.
AI-ism scrub (per plan):
- 16 em dashes removed; replaced with periods, commas, or rewritten
sentences. Final em-dash count: 0.
- "Single source of truth" rewritten ("Stores every secret below").
- Project banned phrases all at 0: load-bearing, out of the box,
guardrails, mental model, first-class, battle-tested, blast
radius, opinionated, primitives.
- "Let's" hits remaining are all "Let's Encrypt" (the proper-noun
ACME CA), not the banned "Let's [verb]" construction.
- Tier-1 AI words (leverage, robust, seamless, delve, etc.): 0.
Docs build clean (67 pages).
agjs
enabled auto-merge (squash)
May 30, 2026 12:26
4 tasks
agjs
added a commit
that referenced
this pull request
May 30, 2026
) After PR #62 closed the five completeness gaps, the user pointed out the rendered hero still looked busy: inline `code` fragments in the PageIntro prose plus a right-rail facts grid plus action buttons, stacked above the page content. The hero alone had four different visual frames. The new visual rule: plain markdown by default. Custom components only when they add genuine comprehension value. The one exception kept on this page is the `<Aside type="caution">` for the MFA encryption key warning, which is a stop-and-read critical caveat. Removed: - `<PageIntro>` with eyebrow + facts grid + action buttons + body. Replaced with two plain paragraphs under the frontmatter title. - All three `<CommandRun>` blocks. Replaced with fenced ```bash blocks. The content is the same; the frame is gone. - The decimal-numbered subsection convention (2.1, 2.2, ...). Plain `### Section name` headings; the body still reads in the same order without the extra hierarchy. Also fixed an out-of-order step in the manual provision path. The old sequence had the operator scp env files into /opt/boringstack/ then git-clone into the same path, which would fail. New sequence: clone first (so the target directory exists), then scp the env files in, then bring the stack up. All six pre-merge greps pass: - em dashes: 0 - banned phrases: 0 - "Let's [verb]": 5 hits, all "Let's Encrypt" the proper noun - Tier-1 AI words: 0 - decorative components: 0 - component imports: 0 Docs build clean (67 pages).
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.
First PR in the docs-rewrite program (plan). Closes the five completeness gaps on `deployment.mdx` the user flagged, plus an aggressive scrub of project-specific AI-flavoured vocabulary.
Completeness
AI-ism scrub
Remaining "Let's" hits are all "Let's Encrypt" (proper-noun ACME CA), not the banned "Let's [verb]" construction.
Test plan