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

Turn contributors list into a paragraph #70

Closed timtebeek closed 7 months ago

timtebeek commented 11 months ago

What problem are you trying to solve?

Looking at larger composite recipes such as Migrate to Spring Boot 3.1 and JUnit 5 Best practices the list of contributors is long. That's to be expected, but it does not help readability of the docs to take up a lot of screen height, and it hides the "Run this recipe with the Moderne SaaS" out if sight.

image

Describe the solution you'd like

I propose to instead turn the list into a paragraph of comma separated Contributors. That highlights their contribution just as much, but shortens the page height quite a bit.

Have you considered any alternatives or workarounds?

We could opt for something similar to what we use in the SaaS. image

okundzich commented 11 months ago

should we reorder run this recipe on moderne to be first before the list of contributors?