plugin-check-legacy icon indicating copy to clipboard operation
plugin-check-legacy copied to clipboard

Provide links to the documentation as part of the check output

Open mrfoxtalbot opened this issue 2 years ago • 1 comments

Given that one of the main goals of this plugin is to allow plugin authors to self-review, I propose that each individual check includes a link to the documentation:

We found [foo] problem on line N You can see how to fix this [foo] issue in this doc [Link to doc]

Ideally, every single check should include a link to the documentation where it is explained/addressed.

mrfoxtalbot avatar Aug 24 '23 09:08 mrfoxtalbot

Noting that this is probably the relevant place but currently the information is very limited. We should expand that documentation to account for other common mistakes.

mrfoxtalbot avatar Sep 06 '23 14:09 mrfoxtalbot