Fix garbled javadoc display inside IDE

[dixler]

Hello!

• Vote on this issue by adding a 👍 reaction
• If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

The providers autogenerated javadoc is currently using our markdown documentation as-is and it displays poorly.

Affected area/feature

[pawelprazak]

An alternative would be to change the default javadoc doclet to a markdown docklet.

[dixler]

fix this:

[t0yv0]

@Zaid-Ajaj mentions a workaround here by installing an extension. I wonder if we could link it up that'd be great (unless there is a better fix).

[t0yv0]

Possible workaround: do not emit codeblocks at all but emit links to them on the docs site (if that's more foolproof to display in IDE).

[t0yv0]

NOTES: markdown parsers in Golang that return AST exist (goldmark, etc). Some are used in pulumi/pulumi.

[t0yv0]

Decided to do the workaround for now and deprioritize the deeper fix.

[t0yv0]

https://plugins.jetbrains.com/plugin/9840-markdown-doclet-for-idea (from @Zaid-Ajaj )