docs: vale fixes — word list and headings in for-app-developers#932
Open
AidanDelaney wants to merge 3 commits into
Open
docs: vale fixes — word list and headings in for-app-developers#932AidanDelaney wants to merge 3 commits into
AidanDelaney wants to merge 3 commits into
Conversation
AidanDelaney
force-pushed
the
docs/vale-app-developers
branch
from
a43a489 to
0c84fd0
Compare
The .vale.ini referenced a Google style package that had never been downloaded, so CI lint was silently passing without enforcing any rules. This commit bootstraps the Google style via vale sync, expands the CNB-specific vocabulary to correctly accept project terms (buildpacks, lifecycle, OCI, SBOM, Podman, etc.) using regex patterns that avoid spurious Vale.Terms conflicts, and excludes SVG files from prose linting. All Google.WordList violations in for-app-developers are resolved: "application" → "app", "in order to" → "to", "above" → "preceding", and heading capitalisation converted to sentence case throughout. The Google Headings rule is extended with ARM and FAQ as known acronyms so question headings containing those terms are not mis-flagged. Signed-off-by: Aidan Delaney <aidan.delaney@gmail.com>
After establishing a Vale baseline, a second pass was needed to clear all error-level findings that were not addressed in the initial sweep. These fixes bring the for-app-developers section to zero Vale errors. Changes include: BlockIgnores for TOML frontmatter in .vale.ini to suppress false-positive Google.Quotes on alias arrays; removal of exclamation marks (Google.Exclamation) from prose and summary fields; replacement of Latin abbreviations e.g./i.e. with "for example"/"that is" (Google.Latin); removal of double spaces after sentence-ending periods (Google.Spacing); fixing "configure configure" repeated word (Vale.Repetition); "container(s)" to "containers" (Google.OptionalPlurals); and "locally-configured" to "locally configured" (Google.LyHyphens). Signed-off-by: Aidan Delaney <aidan.delaney@gmail.com>
AidanDelaney
force-pushed
the
docs/vale-app-developers
branch
from
0c84fd0 to
d856b5f
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.
Expand the CNB-specific vocabulary to correctly accept project terms (buildpacks, lifecycle, OCI, SBOM, Podman, etc.) using regex patterns that avoid spurious Vale.Terms conflicts, and excludes SVG files from prose linting.
All Google.WordList violations in for-app-developers are resolved: "application" → "app", "in order to" → "to", "above" → "preceding", and heading capitalisation converted to sentence case throughout. The Google Headings rule is extended with ARM and FAQ as known acronyms so question headings containing those terms are not mis-flagged.