[website] promote "what-to-check" section from user-guide to more visible location

[gernotstarke]

I really like the combination of diagrams and explanation in the user-guide section "what-to-check".

That's imho exactly the kind of info/docu needed to convince people to use ArchUnit...

Therefore, we might even include such info on the homepage as a kind of "gallery".

The MinimalMistakes template provides a "feature-row" construct which we could apply here,
creating 2-3 rows of examples: Downside: Info would need to be duplicated, as Jekyll imho does not provide flexible-enough include statements...

[codecholeric]

I also think these illustrated examples are great, so I'm all for making them more prominent than being hidden in the user guide in chapter 4 😉 Would you suggest to integrate it as a separate tab on the ArchUnit website? Next to motivation? Or do you think it should be integrated into one of the existing sub-pages? (but then I guess it could also only be motivation, because the other tabs don't really fit)
Could have a separate tab "use cases" 🤔
Maybe we could at least avoid some pain of the duplication by just generating the sub-page automatically when the user guide is created 🤔 This way they would at least not get out of sync... (of course the nicest way would be to just include snippets from the user guide... But I wouldn't know how to do that with Jekyll)

[gernotstarke]

The "feature-row" from MinimalMistakes sounded promising, but I can't get it to render source samples in acceptable ways...

I keep trying...

[hankem]

Whereas I also love to avoid information redundancy, I wouldn't do it at all cost. 😉
Given that there are <10 diagrams in §4. What to Check, which haven't changed for more than 2 years, a stupid duplication (possibly with // keep in sync with XYZ comments) might be good enough?

[codecholeric]

Yeah, I agree. If the automation will only amortize in 50 years, we will likely be fine with duplication 😉
But I couldn't resist to have a little coding Kata to generate the page 😂 It's pretty ugly, but it does the job at the moment and would likely push you to "hey, you updated the section in the user guide? -> the use case page has now also been updated, does that make sense?"
Given how lousy I hacked it there is a good chance it would create mumbo if the format changes (e.g. the size of the headings, the order of the snippets, etc.), but given that this page hardly ever changed I could live with the hacky solution, in case we don't find a clean one. It will be good enough to be reminded that there is a page that should stay in sync.
Looking over it I actually found some snippets I want to update though 😂
Anyway, you can check out my hacky draft here: #482

[codecholeric]

I guess I could have simply linked to the generated PlantUML images as well though, instead of doing magic PlantUML server URL encoding 🤔 But anyway, I don't think it's worth it to spend days on this, except for fun 😉

[codecholeric]

Resolved by #482