Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation ideas #672

Open
pablos-here opened this issue Mar 28, 2023 · 2 comments · May be fixed by #673
Open

Documentation ideas #672

pablos-here opened this issue Mar 28, 2023 · 2 comments · May be fixed by #673

Comments

@pablos-here
Copy link

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
Copy link
Author

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
Copy link
Collaborator

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

@pablos-here pablos-here linked a pull request Mar 28, 2023 that will close this issue
Open
@jonasBoss jonasBoss linked a pull request Apr 7, 2023 that will close this issue
Doc refactoring > README.md and installation.md #673
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Doc refactoring > README.md and installation.md pablos-here/input-remapper
2 participants
@pablos-here @jonasBoss