How to contribute and update the docs and configuration files?

[thomastthai]

I've spent many hours reading and re-reading the docs, config files, asking questions, and writing different config files to test different features. I came from using Karabiner-Elements and now use Kanata. There are opportunities to enhance the docs and configuration files to make them easier to digest, especially for new users. I'd like to contribute to that effort since I'm still new to Kanata and can still offer the new user perspective.

What are some effective ways to contribute without wasting time typing up or editing those files and having the pull requests rejected? Perhaps start an Issue or Discussion about a particular change, flush out ideas and concerns, and then send the PR?

[jtroo]

Thanks for your consideration and contribution!

Creating issues first for any big changes would be good. If it's smaller clarifications or wording improvements in existing docs, simply filing a PR is fine.

[thomastthai]

Sounds good, @jtroo!