Configuration and README edits for readability #950
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The comments in the original file are difficult to read with a text editor that is not colour coded due to the amount of single line comments. Users with no coding knowledge will not understand what they are looking at. The layout of comments and settings were also inconsistent from setting to setting. The comments have been updated to more adequately explain what each setting does and collated into a single block comment. The order of settings has also been changed to more logically group related settings. Lastly, a comment at the top of the file explaining how to edit the settings has been added for inexperienced users, with a suggestion to use an editor other than Windows Notepad.
The wiki is woefully inadequate, and given the amount of users creating issues that end up being closed with links to the wiki and "RTFM," it's abundantly clear the issue is the lack of proper documentation. The link to the wiki now has clarification that the wiki is still under construction to reflect this.
Black logo text on readme page not visible when using dark mode on github web. Added white border to text to increase visibility.
Some users were not aware there was a config file (Davidobot#534), added a sentence pointing out the existence of this file.
berkctezc
approved these changes
Jul 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Made substantial edits to comments in the configuration file to make it easier to read and understand what each setting does, in order to hopefully reduce redundant issues being opened by inexperienced users who do not understand the documentation as is. A few of the comments have not been changed significantly since I am unsure what their functionality is. There is also the possibility some of my comments are incorrect.
Also made minor README edits for clarification.
I would have liked to fork and modify the wiki since some of the FAQ suggestions are out of date (such as the suggestion to disable "also use for axes/buttons" which is no longer a valid setting to change from what I can tell) but since that can't be done from GItHub web I'll try it some other time.