Docs: Linter Rules ToC seems to stop at MISC12

[p-zander]

The last link in the ToC on the page https://robocop.dev/stable/rules_list/ is MISC12, all other rules are not shown:

Just my guess, but I think the TODO added with these recent changes
a974abd#diff-4beea32c2c037d60d44ee9b7cb79b45fd4ba4ea499c5e249aec85a3073e888a8R239-R515
might throw off the generation, as it is interpreted as Markdown:

[bhirsz]

Thanks! I'm curious why it's part of stable release since it should be last release only, which was before that commit -> there is additional issues going on.

[bhirsz]

Ah, my change merely moved the TODO from docs (placed incorrectly) next to class name. If you select "latest" which included recent, not released commit you will see it: https://robocop.dev/latest/rules_list/#misc12-unnecessary-string-conversion

So the bug is already fixed, but I wasn't aware it was a bug, I simply noticed it and moved it :) Unfortunately it was affecting older versions as well, starting from 7.0 - I guess I never manually scrolled past that point.. . I will keep it open to see if it's truly fixed after 8.0 release.

[p-zander]

Yeah, that's right, on latest it is fixed already 👍 I did not deep dive, if that commit was already released. Still interesting to see, why that breaks the generation and how that was unnoticed, right?

[bhirsz]

Like you noticed, # from comment was recognized as markdown header and it didnt play well with site structure. But thats good you noticed it, even if its already fixed, because I will want to prevent it from happenning in the future. I dont want to roll full ui tests on our docs though, maybe I will stick to sanitizing generated content (like rules description) or I will use some markdown linter on oir generated pages. I believe it should be detected as there are rules prohibitng having main header in thw middle of page etc.

[bhirsz]

8.0 was released - it seems it works fine in stable documentation version. Leaving issue open to not forget to add some kind of regression in the future.