Public Access
emilandDevin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
bbf0c81c32
Post-merge / detect-type (push) Successful in 11s
Post-merge / validate-commit-msg (push) Successful in 13s
Post-merge / vikunja (push) Successful in 19s
Post-merge / configure-repo (push) Successful in 15s
Post-merge / release (push) Successful in 45s
Post-merge / sync-wiki (push) Successful in 50s
Post-merge / publish (push) Successful in 32s
Post-merge / badges (push) Failing after 36s
- Fix badge system: clean .badges dir from orphan branch, add version verification, make badges job depend on release (avoids stale version badge race condition) - Add check_doc_versions.py: lint tool that verifies docs version references match current __version__, with --fix for auto-update - Integrate check_doc_versions into release process (auto-updates docs on every release commit) - Add Vale prose linter integration: .vale.ini, custom styles for terminology and code block language, CI step, make target - Fix stale version references in docs (0.27.0 → 0.33.4) - Fix e.g. → for example in docs (Google.Latin Vale rule) - Add CI steps for check_doc_versions and Vale to quality workflow - Add make targets: devx-check-doc-versions, devx-vale Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
47 lines
1.2 KiB
INI
47 lines
1.2 KiB
INI
# Vale configuration for devx documentation
|
|
# https://vale.sh/docs/
|
|
|
|
StylesPath = .vale/styles
|
|
|
|
# Packages are downloaded via `vale sync`
|
|
Packages = write-good, Google, Readability
|
|
|
|
# Minimum alert level to display (suggestion, warning, error)
|
|
MinAlertLevel = warning
|
|
|
|
# Project vocabulary — terms not flagged as spelling errors
|
|
Vocab = devx
|
|
|
|
[*.{md}]
|
|
# Enable style guides
|
|
BasedOnStyles = Vale, write-good, Google, Readability, devx
|
|
|
|
# Google style — relax rules too strict for technical docs
|
|
Google.Contractions = NO
|
|
Google.WordList = NO
|
|
Google.Acronyms = NO
|
|
Google.We = NO
|
|
Google.Will = NO
|
|
Google.Colons = NO
|
|
Google.Headings = NO
|
|
Google.EmDash = NO
|
|
Google.Units = NO
|
|
|
|
# write-good — relax rules too strict for technical writing
|
|
write-good.E-Prime = NO
|
|
write-good.So = NO
|
|
write-good.ThereIs = NO
|
|
write-good.TooWordy = NO
|
|
|
|
# Vale defaults — spelling catches too many technical terms
|
|
Vale.Terms = NO
|
|
Vale.Repetition = NO
|
|
Vale.Spelling = NO
|
|
|
|
# Readability — warnings only, technical docs are naturally complex
|
|
Readability.FleschReadingEase = suggestion
|
|
Readability.ColemanLiau = suggestion
|
|
Readability.LIX = suggestion
|
|
Readability.GunningFog = suggestion
|
|
Readability.SMOG = suggestion
|