Create anchors for checks so they can be linked accurately
nanxstats opened this issue · comments
First off, thanks for documenting these extra checks!
It might be useful to create a heading element for each check so they have linkable anchors. This helps people link individual checks accurately, which benefits linking precise references in code reviews and building code linters.
It is technically possible to have headers under collapsible sections on GitHub, if you favor the existing document structure. Alternatively, the checks can be put in separate Markdown files.
As a relevant example, The VS Code extension markdownlint used to put the linting rules in a single Markdown file under anchored headings, then transitioned to the separate file approach as the rule size grows. In the editor, the identified linting issues have an accurate ID and the associated link to the rule, shown in the screenshot below.
