variar
Update documentation for next release
Hi, I'd like to help. I have gotten to really like klogg, it solves a lot of problems for me! Any suggestions of how/where to start?
Hi, @gbisaga! Thank you! Right now all documentation is in DOCUMENTATION.md file. This file is used to generate html version that is displayed in klogg documentation dialog.
English is not my native language so some phrases in that document might be wired/unclear. Proofreading and wording suggestions are very welcome.
Also I've tried to describe all major features, but some might lack details. For example, I personally do not use "follow file" feature and do not know if documentation for its behavior should be deeper.
Sure thing! I use "follow file" all the time. And the option that lets you turn it on automatically for all new files is fantastic. I'll start looking at it!
I see there's another issue out there about including screenshots. I can do that as I go. I'm not sure how that works with markdown. Is the screenshot checked into the repo next to the .md file and just referenced from there? Like this?
https://github.com/gbisaga/klogg/blob/doc-2020-10/DOCUMENTATION.md
Creating screenshots for docs is also great! Keeping them in separate folder in the repo and adding references will work for viewing Documentation.md online on Github. I'll try to figure out how to package them for klogg built-in documentation dialog.