Can we replace Yahiha with a robot too?

[MaxHillebrand]

As in the main wallet repo, they use StyleCop to auto-enforce specific writing/coding conventions. Is there something similar that we can use for the documentation too?

I mean... I like @yahiheb, but would be nice to get rid of him here too :kissing_heart:

[dennisreimann]

There is markdownlint, which reports warnings like this:

docs/FAQ/FAQ-Introduction.md:249 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
docs/FAQ/FAQ-Introduction.md:251 MD013/line-length Line length [Expected: 80; Actual: 99]
docs/FAQ/FAQ-Introduction.md:252 MD013/line-length Line length [Expected: 80; Actual: 117]
docs/FAQ/FAQ-Introduction.md:254 MD013/line-length Line length [Expected: 80; Actual: 206]
docs/FAQ/FAQ-Introduction.md:255 MD013/line-length Line length [Expected: 80; Actual: 139]
docs/FAQ/FAQ-Introduction.md:258 MD013/line-length Line length [Expected: 80; Actual: 124]
docs/FAQ/FAQ-Introduction.md:260 MD013/line-length Line length [Expected: 80; Actual: 131]
docs/FAQ/FAQ-Introduction.md:261 MD013/line-length Line length [Expected: 80; Actual: 190]
docs/FAQ/FAQ-Introduction.md:262 MD013/line-length Line length [Expected: 80; Actual: 97]
docs/FAQ/FAQ-Introduction.md:266 MD013/line-length Line length [Expected: 80; Actual: 193]
docs/FAQ/FAQ-Introduction.md:267 MD013/line-length Line length [Expected: 80; Actual: 111]
docs/FAQ/FAQ-Introduction.md:268 MD013/line-length Line length [Expected: 80; Actual: 181]
docs/FAQ/FAQ-Introduction.md:275 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### What are the minimal requirements to run Wasabi?"]
docs/FAQ/FAQ-Introduction.md:275 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
docs/FAQ/FAQ-Introduction.md:284 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
docs/FAQ/FAQ-Introduction.md:284 MD013/line-length Line length [Expected: 80; Actual: 139]
docs/FAQ/FAQ-UseWasabi.md:15 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### How do I generate a new wallet?"]
docs/FAQ/FAQ-UseWasabi.md:15 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
docs/FAQ/FAQ-UseWasabi.md:17 MD013/line-length Line length [Expected: 80; Actual: 104]
docs/FAQ/FAQ-UseWasabi.md:21 MD013/line-length Line length [Expected: 80; Actual: 106]
docs/FAQ/FAQ-UseWasabi.md:25 MD013/line-length Line length [Expected: 80; Actual: 96]
docs/FAQ/FAQ-UseWasabi.md:28 MD045/no-alt-text Images should have alternate text (alt text)
docs/FAQ/FAQ-UseWasabi.md:30 MD013/line-length Line length [Expected: 80; Actual: 117]
docs/FAQ/FAQ-UseWasabi.md:31 MD013/line-length Line length [Expected: 80; Actual: 102]
docs/FAQ/FAQ-UseWasabi.md:32 MD013/line-length Line length [Expected: 80; Actual: 110]
docs/FAQ/FAQ-UseWasabi.md:33 MD013/line-length Line length [Expected: 80; Actual: 115]
docs/FAQ/FAQ-UseWasabi.md:34 MD013/line-length Line length [Expected: 80; Actual: 88]
docs/FAQ/FAQ-UseWasabi.md:36 MD045/no-alt-text Images should have alternate text (alt text)
docs/FAQ/FAQ-UseWasabi.md:40 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### Can I rename my Wallet?"]
docs/FAQ/FAQ-UseWasabi.md:40 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
docs/FAQ/FAQ-UseWasabi.md:43 MD013/line-length Line length [Expected: 80; Actual: 144]
docs/FAQ/FAQ-UseWasabi.md:44 MD013/line-length Line length [Expected: 80; Actual: 151]
docs/FAQ/FAQ-UseWasabi.md:51 MD013/line-length Line length [Expected: 80; Actual: 101]
docs/FAQ/FAQ-UseWasabi.md:56 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### What password should I use?"]

We could configure it to fit our needs. I can prepare a branch so that we can have a play with that.

[MaxHillebrand]

I'm ignorant on how this actually works, would we need to have a specific text editor to make it work? For example I use vim, does it work with this too?

I have no clue if it is useful, so it would be nice to have a branch to test what is possible. It's not priority @dennisreimann , but if you have the mind for it, pleas do!

[dennisreimann]

It is a script that can be run via the command line. There might be editor integrations too (e.g. for Visual Studio Code there is).

[dennisreimann]

See the explanations in #526.

[davterra]

It is a script that can be run via the command line. There might be editor integrations too (e.g. for Visual Studio Code there is).

Yeah, I've been using the markdownlint extension in vscode, and being new to markdown, it has helped me. I've tried some markdown tools in Atom, but nothing really as good. I would love to customize it for the styles preferred here.

[dennisreimann]

afaik it should pick up the config from the .markdownlint.json file. Let's have a play with the config in my PR and see whether or not this tool helps with replacing Yahiha 😆