search

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

Sort the recipe menu alphabetically (or at least the main categories) #119

Closed Philzen closed 2 months ago

Philzen commented 3 months ago

What problem are you trying to solve?

I was just looking at the description of "AssertJByteRules Refaster recipes". Then i wanted to look up something in the Java section … finding that section took me ages, because the menu looks like this:

grafik

Describe the solution you'd like

Maybe it's just me, but i'd argue it's a common expectation to find the Java category right above "Jenkins". But it is much further up, somewhere below "Search" and above "Analysis" :see_no_evil:

grafik

Are you interested in contributing this feature to OpenRewrite?

Yup.

timtebeek commented 3 months ago

Thanks for the suggestion! I'm not sure what order we use, but it feels like we use the order of how the recipe dependencies are declared. Might indeed make more sense to add a predictable ordering, especially with how much the catalog has grown.

Note that I moved the issue to the repository that parses the recipes and generates the docs. It's a bit of a unpolished script, but works well enough up to now.

mike-solomon commented 2 months ago

I believe I've fixed this so the catalog is sorted alphabetically now. If you run into any issues with it - please let me know :D