FAQ usability rewrite.

[jamesbt365]

Begin the rewrite of the FAQ pages, open to suggestions.

I have no idea how to format this nicely or write proper docs (or English at all really) so a review on what I have written would be nice.

Incomplete as I'm opening this, so marking as draft until complete.

This will break the FAQ snippets in Discord, as well as any previous links sent in GitHub or elsewhere. I can try and make it as compatible as possible if that is desirable, but I don't know how to handle that at this time.

fix #42
fix #43
fix #109
fix #110

[jamesbt365]

Its bulky currently, but I'm not sure on how to make it look better or thin it out and yes, I'm aware of a few missing newlines.

[jamesbt365]

I have added back all the FAQ entries for Windows, some reworded and some mostly the way they were.

I feel like further changes are required to have the same "flow" on the other entries like how the first one is structured.

I can't write the titles as I want because longer titles mean it squishes the page content to the right more, which is undesirable here. If I remember I'll try and figure out a way to remedy this so I can use full length titles.

[jamesbt365]

This pull request currently supersedes #89, will fix #110 and #109 and potentially OpenTabletDriver/opentabletdriver.github.io#116 when done.

[Sublimelime]

Several grammar fixes, addition of commas, and some elaboration.

[jamesbt365]

I have gone ahead and pushed the start of the Linux FAQ rewrite, I'm not happy with it so far because I feel like grouping stuff together may result in making it harder to point people towards the right instructions, but the readability of this is much better.

I have left a placeholder instead of listing the message for missing udev rules as this is usually indicated by a hidraw error (the log message saying udev rules don't exist has been gone for a long time now OpenTabletDriver/OpenTabletDriver#2333) but the hidraw error also occurs when OTD tries to open other devices that may not be tablets, so it may not be the most reliable message to use.

[jamesbt365]

TODO (maybe):

• Fix formatting on some segments (I believe this is done?)
• Fix english
• Make it not so cramped
• Try and fix the contents list.
• Add an extra part for udev misconfiguration, as OTD will occasionally show the hidraw message for non tablets resulting in the same problem.
• Amend the service instructions
• Include non-systemd distro instructions
• List artist mode for reasons other than pressure (misbehaving cursor in wine, other XWayland applications and SDL applications on Wayland)
• Cleanup other less important and or redundant instructions

The MacOS FAQ probably will not be handled in this pull request as we do not have an extensive FAQ for this platform at this current moment in time.

[jamesbt365]

I pushed a change that will affect how the "contents" segment is shown, I have tested this explicitly in firefox testing as a pc and using responsive design mode to check how a mobile device will handle it. I want opinions on this change but it makes the wiki far less cramped.

old:

new:

[jamesbt365]

I've gone ahead and pushed some stuff on artist mode, I'm not sure if we packaged the smoothing override yet so I've gone ahead and included it here.

[gonX]

I'm not sure if we packaged the smoothing override yet so I've gone ahead and included it here.

Smoothing override is not packaged yet, but I think it's planned. OpenTabletDriver/OpenTabletDriver#2895 tracks this.

[jamesbt365]

New push should fix OpenTabletDriver/opentabletdriver.github.io#116. I went down the route of explaining what convert_to_portable.bat does rather than directly the userdata folder because we have that script packaged with all Windows releases now.

I have also included basic non-systemd instructions. #42

[jamesbt365]

I'm not very happy with the way that the ENOENT solution is placed, it
feels completely out of place and I just want to remove it entirely and
tell people to refer to their distros documentation on how to modify the
kernel.

The only place where the problem is typically present is on gentoo and
people using gentoo probably know how to enable and disable specific
parts of the kernel, so pointing them towards the documentation for
gentoo or just telling them to visit it is probably enough.

[jamesbt365]

Other than formatting, SPAG (includes turning british english into american english) and some elaboration on using diagnostics to find missing udev rules (current method is has flaws) I think I am ready for review!

[jamesbt365]

This pull should:
supersede #89
fix #42
fix #43
fix OpenTabletDriver/opentabletdriver.github.io#116
fix #109
fix #110

[jamesbt365]

Note to self: include switching to debug mode to see the logs in console.

[gonX]

LGTM aside from my suggestions, current formatting and subject ordering isn't the greatest but it's a huge upgrade over what we have now

[gonX]

6eaa160 preview:

[Sublimelime]

Gone over it again with various grammar fixes, comma and info adds, etc. Looks good otherwise.

[gonX]

This doesn't entirely fix OpenTabletDriver/opentabletdriver.github.io#116 btw.

That issue requests talking about the userdata folder, and that folder is only vaguely referenced in this PR's current state.

But it does fix #117

[jamesbt365]

If it isn't enough I'll just remove it from scope. I don't exactly have the drive to "finish" this any more than I currently have so it will remain out of scope unless anybody wants to submit a pull request to my fork to add it.

[jamesbt365]

This should be in good enough state to be merged as is, but as it stands I am really losing the drive to push anything else into this at the current time, more along the lines of the whole project overall ;-;

[jamesbt365]

done on migration to opentabletdriver.github.io