OpenTabletDriver / OpenTabletDriver/opentabletdriver.github.io

Linux install section should more clearly mention how to start the daemon

Open Beginner friendly
#334 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue wiki
Dominant language
HTML
Stars
36
Forks
10
Avg merge
12h 32m
Merged PRs (30d)
9

Description

Currently, it only talks about auto-starting the daemon. I've seen too many users getting confused over this current wording, so I think that it would make sense to clarify that the daemon needs to be started for the driver to work, and then refer to the auto-start section (or better).

Relevant snippet(s) that needs to be reworded:

https://github.com/OpenTabletDriver/opentabletdriver.github.io/blob/c43d9ff48f6c40778058e4c5d0cff056cfec647c/site/_wiki/Install/Linux.md?plain=1#L25

Note that multiple of these exist through each install guide. It may be smarter to make an include file that can be included per-OS, or similar, to reduce workload.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with site/_wiki/Install/Linux.md around line 25, then inspect the corresponding sections in the other install guides. Clarify that the daemon must be started for the driver to work and refer users to auto-start instructions; done means the wording is consistent across the guides or uses a shared include if appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.