-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix/vale errors and warnings #177
Fix/vale errors and warnings #177
Conversation
These still show up as errors/warnings but I feel like those aren't valid errors/warnings. Most are xrefs, which should be excluded according to Vale documentation (https://vale.sh/docs/topics/scoping/#restructuredtextv). One is even between a vale off/on block and still shows up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this PR! A couple of things:
Here's our technical writing styleguide: https://contribute.mautic.org/education-team/technical-writing-styleguide.
We capitalise proper nouns, including the features of Mautic. This is to help people differentiate between when we're talking about a feature versus referring to something else - eg Email (the thing in Mautic) versus email management (in general).
Also we don't usually make changes for the Google styleguide core files (if they're updated in the future it will be overwritten) so I was interested in what the reasoning was there?
…er has write perms
Co-authored-by: Ruth Cheesley <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for all your work on this @nick-vanpraet!
LGTM 🚀
Description
Fixes #22