The repository to find popular Vale rules that are:
- Comprehensive: Exhaustively prepared from reliable sources
- Easy to Implement: Tested and well-documented
- Permissively Licensed: MIT compatible licensing
Vale is an open source documentation software, accessible both from the command-line or through integrations. An important feature of this tool is the ability to support custom styles and lint actions. Vale demonstrates this capability within the package hub where you can find style guides prepared for Google and Microsoft.
Many organizations, including Red Hat and Splunk, often publish their Vale configurations with permissive licenses. The repositories with these rulesets can be very useful to learn and adapt from. However, they also reveal that many technical writers have re-iterated upon similar rules, aiming to deliver the same results.
We want to improve upon commonly listed rules to build a non-affiliated repository hosting exhaustive lists that everyone can adopt. This might significantly reduce the redundant work that each organization has to complete. Furthermore, the burden of maintenance can be lowered if a trusted central repository hosts files while receiving fixes from everyone.
We plan to build more comprehensive rules by:
- Expanding upon primary sources rather than create arbitrary lists.
- Combining pre-existing work that can be easily accessed and categorized.
- Improving the application of certain pre-existing rules so that more projects can benefit from them.