Make doc Vale and Markdownlint check pass

Description

Requires the doc team to decide what rules to keep or not.

See the two out files as work base.

Most lint issues can be fixed by removing trailing spaces (there’s also a config in IDE to prevent that) and write lines with the correct length.

Vale rules have to be triaged. For instance, error '!!!' is hyperbolic. proselint.Hyperbole is a false positive as it’s not an hyperbolic but a MD extension syntax. So the rule has to be disabled and replaced by a custom one:

1 2 3 4 5 6 7 extends: existence message: "'%s' is hyperbolic." level: error nonword: true tokens: - '[a-z]+[!]{2,}' - '[a-z]+\?{2,}'

Note the + instead of * in regexp…

Status

Assignee

Nicolas Massart

Reporter

Nicolas Massart

Refinement State

Requires Team Review

Scrum Team

Pliny

Epic Link

Priority

P3
Configure