Giters

danvergara / dblab

The database client every command line junkie deserves.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[FEATURE] Add documentation with mkdocs

valerybriz opened this issue · comments

commented

Currently the only documentation for the project is in the repo and in the help command of the cli
It would be nice to have a documentation page in order to describe the features of the library and also to expose examples and tutorials that can help new adopters.

The documentation would be created with MKDocs and the material template since it looks clean and it is easy to navigate. Also it is easy to maintain and update using github actions.

commented

I will start mounting the base of the documentation site with MKDocs and material and then start creating the content of it based on the current documentation of the repo.