[clazy] [Bug 394237] IDE-friendly URLs to documentation pages of checks

[Nikolai Kosjar]

https://bugs.kde.org/show_bug.cgi?id=394237

--- Comment #2 from Nikolai Kosjar <nikolai.kosjar at qt.io> ---
Hi Sergio!

The checks.json looks indeed useful and could be used to construct the URL.

However, this seems to be a bit overkill for such a simple use case. We would
need to ship it (and update it later) with Qt Creator one way or the other and
then read/parse the JSON just to find out the level of a check, and that only
to construct the correct URL.

Note that currently the documentation URL can be easily constructed for clang
tidy checks, e.g:

http://releases.llvm.org/6.0.0/tools/clang/tools/extra/docs/clang-tidy/checks/modernize-make-unique.html

The version is also included in the URL which is also very nice to avoid links
to inconsistent documentation.

For clazy, maybe some redirecting pages could be used to keep the current
hierarchy, and to also have level-free URLS for the checks? For example, could
<url part>/checks/README-connect-by-name.MD could redirect to <url
part>/checks/level1/README-connect-by-name.MD? I'm not to familiar with github,
but there seems to be some documentation into that directon:
https://help.github.com/articles/redirects-on-github-pages

-- 
You are receiving this mail because:
You are the assignee for the bug.