Documentation ideas - Githubissues

sezanzeb / input-remapper

🎮 ⌨ An easy to use tool to change the behaviour of your input devices.

GNU General Public License v3.0

3.88k stars 161 forks source link

Documentation ideas #672

Open pablos-here opened 1 year ago

pablos-here commented 1 year ago

Hi,

I am wondering if there is any interest in updating the documentation.

I would be willing to submit a PR with documentation refactoring.

Below are some points I'd like to refactor/document:

Ensure Macros is up to date.
Replace quick overview of macros , with a link to Macros.
Comb through all the text to ensure clarity.
Document any non-GUI tunables - where the user must hand-edit a .json file

Any other ideas?

pablos-here commented 1 year ago

The reason I'd like to replace make the replacement is so information is not replicated. It's always best to centrally locate documentation as it minimizes stale text. :)

jonasBoss commented 1 year ago

Contributions are always welcome 👍. I will happily review any changes you suggest.