Currently we do not have any language checker for our documentation system. In previous we used igor which has not been upgraded and sometimes are also not compatible with AsciiDOC and additionally the maintainer is no longer a committer anymore. Considering this and widespread use of Vale we have given a test on vale and initiating introduction of vale with some basic set of rules.
That is our brand value. Contractions: Contracted words should not be used. This rule avoids all contractions and suggests full words. Hang: We often try to use the word hang to convey the meaning that the application has stopped responding.
This rule proposes better wording Repetition: Often while working we type the same words twice; this mostly happen we leave the keyboard while writing and returning to desk. This rule warns the user Hyphens: Often adverbs ending with 'ly' are being added with a hyphen which is wrong.
It has also an exception list to ignore the FreeBSD specific terms. Currently the list is a basic one with minimal words just as a proof of concept The next step will be restarting the CI process of FreeBSD docs, reduce noises and implement git hooks.
