Refactor doc generation

[DerManoMann]

Lots of similar code and variations of style/layout.

One key element is to move away from using HTML to use more vitepress features.

Related to #1741 - defining some rules about how to document code, etc.

[DerManoMann]

@Kiina is this something you might be interested in? Just drafting some layouts for generated docs in (mostly) Markdown for vitepress to consume.

[Kiina]

Okay I took a look at how the doc is generated and it's kinda wild with regex over the php code and then building some html with echo. Tbh I haven't had to write a documentation generator before but it's probably not the worst idea to lean on something already established. Laravel uses doctum for the generated docs, it seems like it should be able to output markdown using twig templates, but I'm not sure if using it would require a change in how stuff is documented in code. And funnily enough the doc generator has no real documentation. But if it works it would probably decrease the complexity drastically if we don't have to deal with parsing the source ourselves

[DerManoMann]

Not sure I was planning on that much work:)
I think I am more looking for some consistency in the markup that then translates into good HTML. How we generate that is a second step.

I'd prefer twig for templating if I had to. Some macros, shared everywhere and that's it (ha ha, I know...)

The parsing of the sources could be cleaner, I agree. Happy to refactor and clean up.

[DerManoMann]

Let me think about this a bit, maybe have a little play around.