docs(deployment): strip PageIntro + CommandRun, plain markdown only - #63
Merged
Conversation
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.
Second pass on `deployment.mdx` after PR #62. The user pointed out the rendered hero still looked busy: inline `code` fragments in PageIntro prose, right-rail facts grid, action buttons, all stacked above the actual page content. Four visual frames before the reader gets to step 1.
Change
Plain markdown only. The one exception kept on the page is `<Aside type="caution">` for the MFA-encryption-key warning, which is a genuine stop-and-read caveat.
Removed:
Also fixed: out-of-order step in the manual provision path. Old sequence had scp into `/opt/boringstack/` before the git-clone, which would fail (clone needs the directory not to exist or to be empty). New sequence: clone first, then scp, then bring stack up.
Pre-merge checks (all pass)
Where this fits
First PR in the 11-PR docs-rewrite program. Establishes the per-page shape every other PR will follow: plain markdown, zero decorative components, the same six greps must pass on every rewritten file.
Test plan