search

mage-os / devdocs

Mage-OS devdocs
13 stars 24 forks source link

[#34] add alex #77

Closed Morgy93 closed 10 months ago

Morgy93 commented 1 year ago

As mentioned in https://github.com/mage-os/devdocs/issues/34#issue-1818138857 I added alex to the check on changed markdown files.

Example output:

image
DavidLambauer commented 1 year ago

Thank you for providing this. Could you mark this PR as draft, for now?

Looking at the output that it gives us, I think we make it a fully optional thing.

CleanShot 2023-10-23 at 13 05 45@2x

I can understand wordings around master/slave or black- and whitelist, but in the sense of execution, the context is just different. I suppose, that we can configure the ruleset. I'll dig into it and see if we can use some of them

Morgy93 commented 1 year ago

Thank you for providing this. Could you mark this PR as draft, for now?

Done.

I suppose, that we can configure the ruleset. I'll dig into it and see if we can use some of them

Yes, it's highly configurable and we can even simply allow certain words: https://github.com/get-alex/alex?tab=readme-ov-file#configuration

You can run it for every file in the directory / repo and check the output. Afterwards adjust the rules to your likening.