Docs Overhaul

[ZeroIntensity]

Feature description

Complete rewrite of the docs, including both the markdown and mkdocs theme. Should hopefully look something like NextJS or Tailwind when done.

Feature example API

N/A

Anything else?

No response

[muresan-gabriel]

Hello! I'm new to GitHub contributions. Found this Open Issue and I'd like to give it a try. Never really worked with mkdocs, but I'll have an in-depth look at how the docs currently work and provide a solution to this Open Issue. I see it still uses CSS, so it seems to be fine by me.

Do you require Figma prototypes before development or could I jump straight to styling?

Thank you in advance!

[ZeroIntensity]

I don't use Figma, so you can jump right in. If you need any help with MkDocs, they have a good documentation on designing themes. This is a big issue, so I'll work on it alongside you. Be sure to join the discord if you have any questions.

[ZeroIntensity]

I think it might be possible to build the docs in Next, would that be helpful if I set that up?

[muresan-gabriel]

Sure thing! Thanks a lot! Whichever you think would better fit your preferences. I can get into the MkDocs documentation without an issue, but I can jump into Next as well. Whatever works for you.

[ZeroIntensity]

I think let's stick with MkDocs for now, since it's really easy to write documentation for it. If you want to use Next, be sure to let me know.

[muresan-gabriel]

No worries, bud!

Having that already set up is great and I'd rather accomodate myself around what you have, than force you to use something else.

Cheers, I'll keep you posted on Discord with the progress.

[ZeroIntensity]

Vue and Nuxt are also both good examples of how this could turn out.

[hasansezertasan]

I highly encourage you people to stick to the MkDocs, it's great and it's python 😎