Lean and DRY pass over the 0.16.0 release artifacts#2682
Open
chalin wants to merge 4 commits into
Open
Conversation
Cross-page DRY pass over the 0.16.0 release artifacts (one home per fact): - Release post: links the Hugo guide's language-API renames instead of restating them; replaces the fresh-clone setup recipe with the existing-install update step and a link to Other installation options; links Install PostCSS; the version footnote links the official support policy instead of restating it. - Changelog: drops upgrade advice from the Hugo-floor entry (the google#2593 citation moves to the language-API entry); trims the favicon filename list and discovery restatement (docs own the reference detail); tightens the PostCSS entry. - Docs: Install PostCSS now owns the Browserslist defaults compatibility statement (was stated only in the post and changelog).
- Reworks the Release summary as a selective ToC (one bullet per section with a glue clause), matching the 0.15.0 summary style; actions and details stay in their sections. - Links the two unlinked skim items in Ready to Upgrade. - Drops intra-page restatements: theme/package.json ownership was stated three times (npm-deps section is its home), and the shared chrome section stated the full-is-default fact three times and experimental twice in one paragraph. - Compresses the nested-module-tag note to its user-relevant point.
Captures the review guidance applied to the 0.16.0 post in its canonical home (Content placement): upgrade posts stay maximally actionable yet lean, the release summary reads like a selective table of contents, and each fact has one home section. Also spells out 'devs' (flagged by cspell).
Applies the same one-home-per-fact review as the release post: - Removes the trailing 'Recommended minimum Hugo version' section: it restated the intro, the Hugo-version section, and the Upgrade section, and nothing links to it. Its one unique bit, the hugoVersion.min YAML shape, moves into the Hugo-version actions. - Homes the hugo-extended and hvm install commands in the Upgrade section (they appeared twice); the Hugo-version actions link there. - Collapses the node-tools body/actions near-verbatim duplication of the 0.163.2 and 0.163.3 fix conditionals: the actions own them. - Drops vestigial 'upgrade to 0.160.1' advice from the amp-escaping and template-cleanup actions -- 0.160.1 is already the mandatory minimum -- and folds the link-render-hook shielding nuance into its action bullet. - cSpell: adds contentbasename and downscaling, pre-existing words in this file that the spell check flags.
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.
Review round over the 0.16.0 release artifacts, applying the Content placement guidance (one home per fact; lean and DRY):
defaultscompatibility statement a current-state home in the docs (Install PostCSS); it was stated only in the post and changelog.hugo-extended/hvminstall commands in the Upgrade section, collapses the node-tools body/actions duplication, and drops vestigial upgrade-to-0.160.1 advice (it is already the mandatory minimum).Preview: release post · Hugo guide · changelog