Skip to content

Conversation

vinckr
Copy link
Member

@vinckr vinckr commented Apr 21, 2022

We might add a style linter down the line with individual styles, as of now the write-good (or other style collections) are too broad to be enforced (and not useful if not enforced)

@vinckr vinckr requested a review from tomekpapiernik April 21, 2022 08:30
@vinckr vinckr self-assigned this Apr 21, 2022
@vinckr vinckr changed the title disable vale linter chore: disable vale linter Apr 21, 2022
Copy link
Contributor

@tomekpapiernik tomekpapiernik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will make docu reviews easier on the eyes, thanks :) I hope we'll be able to implement a basic spelling check in place of this set of rules soon. Will be more useful IMO

@vinckr vinckr merged commit 01f1995 into master Apr 21, 2022
@vinckr vinckr deleted the disable-vale-linter branch April 21, 2022 08:42
@aeneasr
Copy link
Member

aeneasr commented Apr 21, 2022

Yes, can we add at least some basic spell checking again? I found it quite useful. It's also good for brand control (eg Ory and not ORY)

@vinckr
Copy link
Member Author

vinckr commented Apr 21, 2022

Markdownlint is still active:
https://github.com/ory/docs/blob/master/docs/markdownlint.yml
This also includes proper-names, where things like Ory/ORY get checked.

So what we removed here was just the write-good rules.

You can always run vale locally if you like the write-good rules. I have a vale.ini in my home folder and just do vale documentpath before pushing.

I added a draft PR for a proper spellchecker (something we did not have before):
#778

This was referenced May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants