moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Feature Request: Build a pipeline to test the adherence to documentation style guide #181

Closed Namyalg closed 1 year ago

Namyalg commented 2 years ago

Is your feature request related to a problem? Please describe.

Currently, the documentation is reviewed by the SME to ensure technical correctness. However, there is no mechanism existing to verify correctness of the language/expressions used.

Describe the solution you'd like.

I would like to use the github action, vale-action, on every PR, the changes made are tested for language correctness. The Google Documentation Style Guide will be used as the standard.