openrewrite / rewrite-recipe-markdown-generator

Utility that generates OpenRewrite recipe documentation in markdown format for all recipes on the classpath.
Apache License 2.0
2 stars 7 forks source link

Add GitHub icon to GitHub link #82

Closed mike-solomon closed 7 months ago

mike-solomon commented 7 months ago

People are missing the link to the GitHub source for recipes. It was suggested that we add the GitHub icon in front of the link to draw people's attention to that.

Making an issue to track that.

vlsi commented 7 months ago

It would be better if a corresponding text could be added as well. For example: "if you need to customize the set of rules, you might copy the rule sources from ..."

A nice side-effect would be fixing the set of rules, so they would not accidentally change as users upgrade openrewrite

mike-solomon commented 7 months ago

I updated the title and added a note about the recipe sources. I think this fixes the issue. I didn't see an easy way to add the icon but I think that's less important with the other two changes.

image

Resolving.