Skip to content

Fix pre-existing Vale style debt across docs - #3842

Merged
stereomon merged 4 commits into
masterfrom
fix-vale-preexisting-style-violations
Aug 6, 2026
Merged

Fix pre-existing Vale style debt across docs#3842
stereomon merged 4 commits into
masterfrom
fix-vale-preexisting-style-violations

Conversation

@stereomon

Copy link
Copy Markdown
Contributor

Summary

  • Fixes ~73 genuine style violations surfaced when CI's vale-lint moved to v3.17.1 (unpinned snap install in #3841 picked up a newer release with stricter rule matching): Backoffice -> the Back Office in prose, vague "run the following command" framing reworded to state the action directly, 3rd -> third in idiomatic/positional use, and one squished-together table cell.
  • Each of the ~110 originally-flagged lines was checked individually before touching it. About a third are false positives — vale matching hostnames, module/package names, log and property identifiers, correctly-numeraled ordinals (>= 10), and a literal date-format data example as if they were prose — and are intentionally left alone; rewriting them would corrupt real names/data.

Test plan

  • Ran vale 3.17.1 (the version CI now installs) locally against the full docs/ + _includes/pbc/ tree before and after: 110 errors -> 37, with all 37 remaining confirmed as false positives.
  • CI green on this PR.

Genuine terminology and phrasing issues surfaced by vale 3.17.1, triaged one by one: 'Backoffice' -> 'the Back Office' in prose, vague 'run the following command' framing reworded to state the action directly, '3rd' -> 'third' in idiomatic/positional use, and one squished-together table cell fixed.

Left untouched: vale's remaining ~37 flags are false positives (hostnames, module/package names, log and property identifiers, correctly-numeraled ordinals >= 10, and a literal date-format data example) that would be wrong to rewrite.
@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for spryker-docs ready!

Name Link
🔨 Latest commit 1048136
🔍 Latest deploy log https://app.netlify.com/projects/spryker-docs/deploys/6a745bed3158b700081f709f
😎 Deploy Preview https://deploy-preview-3842--spryker-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@stereomon
stereomon marked this pull request as ready for review August 6, 2026 10:14
@stereomon
stereomon merged commit 9da5878 into master Aug 6, 2026
15 checks passed
@stereomon
stereomon deleted the fix-vale-preexisting-style-violations branch August 6, 2026 10:32
@profuel profuel mentioned this pull request Aug 6, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants