Skip to content
This repository has been archived by the owner on Dec 13, 2021. It is now read-only.

Adopt a style guide for docs #6

Open
HarshCasper opened this issue Dec 4, 2021 · 1 comment
Open

Adopt a style guide for docs #6

HarshCasper opened this issue Dec 4, 2021 · 1 comment

Comments

@HarshCasper
Copy link
Contributor

Description

Since we have a lot of documentation across Enarx and they would be further expanded, it would make a lot of sense to adopt a style guide for consistency and standardization.

One of the options that can allow us to implement this would be Vale. Vale is a command-line prose linter that can be adopted with any popular style guide (or develop our own!) to analyze our language usage, find typos and wrong grammatical usage.

It can also be adopted to be used with a CI service, like GitHub Actions.

@MikeCamel
Copy link

I have some reservations about this, tbh. Particularly if it's going to require rewriting. We have contributors with American and British English as their native tongue (not to mention non-native speakers), and I don't want us to have to manage lots of pieces. Nor do I want expert writers of the language to have to rewrite because their text fails the linter. I'd be interested to see results for some of our existing text.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants