trinodb / trino-gateway

Home Page:https://trinodb.github.io/trino-gateway/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create website for docs instead of raw markdown pages

mosabua opened this issue · comments

Decided on using mkdocs with material theme with @electrum and all members at dev sync

Tasks

using this theme - check for CI and GH pages setup - https://github.com/squidfunk/mkdocs-material

and look and feel and more

https://squidfunk.github.io/mkdocs-material/

just wondering what's the additional benefit of moving it to a separate website compared to raw markdown? Of course markdown is very developer focused, but github renders the markdown so even non-developers can still see the docs in a website fashion.

We can make it much better looking and importantly much better organized and usable. We also get search and so on. And when its all set up its actually easier to maintain and update.

@andythsu It's not "moving". We can still see the raw markdown rendered by GitHub.

That too @ebyhr ... but over time the site will be much better.. also the navigation on the raw markdown source goes away..