ci: Lint documentation

[kbond]

https://github.com/OskarStark/doctor-rst

[cezarpopa]

Hi Kevin,

I hope all is well, I was wondering whether this is still relevant for the project? I have already configured the linter and initial rules and could draft a PR for it.

One point I am particularly unsure about is the initial set of rules for the RST linter.

Would something like this suffice as the initial config?

rules:
    short_array_syntax: ~
    max_blank_lines:
        max: 2
    yaml_instead_of_yml_suffix: ~
    composer_dev_option_not_at_the_end: ~
    versionadded_directive_should_have_version: ~
    unused_links: ~
    filename_uses_underscores_only: ~

Thank you, Cezar

[nikophil]

Hi @cezarpopa

that would be very nice to add some linting to the doc (your last PR is actually a proof that this issue is still relevant :innocent:)

I'd say it would be nice to use OskarStark/doctor-rst: it ships with a lot of opinionated rules, and I think it is used to build Symony's doc as well (@OskarStark could you confirm?)

[cezarpopa]

Hi @nikophil,

that sounds great, I can confirm that OskarStark/doctor-rst is used in the symfony-docs repository as well - https://github.com/symfony/symfony-docs/blob/7.1/.doctor-rst.yaml

I'll try to get a PR drafted tomorrow for it so we can have a wider discussion there around the initial rules that the docs linter should use.

Thank you!

[OskarStark]

Yes we use it at Symfony docs, but just for linting, not for building 👍🏻

[cezarpopa]

Hi @kbond @nikophil,

I've drafted a PR for the documentation linter here #657, I'd love to hear you thoughts on that.