Keeping Mycli.net Documentation Up-To-Date

dbcli / mycli

A Terminal Client for MySQL with AutoCompletion and Syntax Highlighting.

http://mycli.net

Other

11.39k stars 657 forks source link

Keeping Mycli.net Documentation Up-To-Date #432

Open tsroten opened 7 years ago

tsroten commented 7 years ago

Our mycli.net documentation is falling behind. This needs to be:

part of our normal release process
possibly automate parts of it? e.g. config file, help commands, etc.

I'm wondering -- is it confusing that the FAQs on mycli.net are not related to using mycli? They are FAQs about the project.

tsroten commented 7 years ago

Any automation would only happen at release time so as to not keep pre-release documentation on the public site.

Or, maybe it's too difficult (or not worth the effort) to automate. It might just be something that we check prior to every release and update as needed.

andrewimeson commented 5 years ago

It would be nice to have the online docs generated either from this repo or a separate documentation repository, that way others can make contributions. A lot of open source projects seem to be using Read the Docs these days.

tsroten commented 5 years ago

@andrewimeson Hello! We do actually have a repository people can contribute documentation to: https://github.com/dbcli/mycli.net

We definitely welcome any help with documentation 😄