feat: Add Vale documentation linting #193
Draft
Conversation
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
This adds Vale prose linter configuration for documentation quality based on Source Network brand guidelines. Includes: - 11 custom DefraDB style rules for branding, terminology, and voice - Vocabulary files with approved/rejected terms - Makefile integration (make lint:docs, make lint:docs:strict) - GitHub Actions workflow for PR linting - Updated .gitignore for Vale packages Custom rules enforce: - Product name consistency (DefraDB, SourceHub, Orbis, LensVM) - Technical terminology standards (edge-first, Edge AI, etc.) - Brand voice (avoid corporate buzzwords, hedging language) - Second-person voice in developer documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Deploying docs-source-network with
|
| Latest commit: |
28efa09
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://258ef71e.docs-source-network.pages.dev |
| Branch Preview URL: | https://jack-docs-vale-linting-setup.docs-source-network.pages.dev |
4 tasks
Author
|
WOW Separate PR for fixing this? |
- Fix README typos (Cloudfare → Cloudflare, remove exclamation) - Disable Vale.Terms (conflicts with custom rules) - Expand vocabulary with 100+ technical terms - Add both case variants for code context terms Reduces errors from 1725 → 646 (63% reduction). README now passes with 0 errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
make lint:docs,make lint:docs:strict)Custom Rules
Error Level (Branding)
Warning Level (Style)
Suggestion Level (Quality)
Usage
Test plan
🤖 Generated with Claude Code