[Bug]: the languages link in the API docs are broken / no listing of supported languages?

[jmhodges]

What happened?

In the API docs from the readme, the format_multirun API call has a link named languages in its kwargs section.

But that link goes to https://registry.bazel.build/docs/aspect_rules_lint/1.10.2#languages which leads nowhere.

I've not been able to find where to find a listing of the supported languages and tools anywhere else, so it'd be nice for this link to be fixed

Version

Development (host) and target OS/architectures: N/A

Output of bazel --version: N/A

Version of the Aspect rules, or other relevant rules from your
WORKSPACE or MODULE.bazel file: N/A

[alexeagle]

Yup, the new docsite hosting I did in my spare time doesn't have any broken link checking, and I'm sure there are a lot of places that need either a source change or something in the renderer to correct links that expected to be served off GitHub.

[jmhodges]

Thanks so much for doing it! Happy to try a patch if you can know where the link should go.

[alexeagle]

Just search the page: https://registry.bazel.build/docs/aspect_rules_lint/1.10.2#rule-languages

It's because https://github.com/bazel-contrib/bcr-ui/blob/main/components/StardocNav.tsx#L38 generates the anchor with the typename- prefix but existing code assumed the anchor is just named for the symbol.

I think we should probably change bcr-ui since more docs are probably broken, either changing that logic or use a third-party library like https://www.bryanbraun.com/anchorjs

I'd like as a first step to have a detector for broken links - it could be against the live site, but would be better if we can detect them before a ruleset even releases their docs.

So - it's a bit of a project to do properly.

[jmhodges]

Okay, how about I send a patch to add the supported languages to the formatting.md file? Just since we're a ways away from fixing the links.

That's kind of the "intro to rules_lint formatting" doc, anyway, and it would be good to have redundancy so folks are sure to hit the important stuff.

[alexeagle]

Sure, small improvements are good too - I just know the problem will keep popping up until there's a principled fix