[Documentation - BUG] Guidance in the Usage Document
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Shell
- Stars
- 105
- Forks
- 63
- PR merge metrics
- No merged PRs in 30d
Description
Looks like the content actually comes from docs/usage.d/userData-Linux-bash.sh. Probably wants to be updated to:
#!/bin/bash
PYPI_URL=https://pypi.org/simple
# Ensure pip modules are globally-readable
umask 022
# Install pip
python3 -m ensurepip
# Install setup dependencies
python3 -m pip install --index-url="$PYPI_URL" uv
# Install Watchmaker
uv pip install --index-url="$PYPI_URL" --upgrade watchmaker --system
# Run Watchmaker
watchmaker --log-level debug --log-dir=/var/log/watchmaker
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/usage.d/userData-Linux-bash.sh and compare its current guidance with the commands and environment variables shown in the issue. Done means the usage guidance reflects the requested Python, pip, uv, Watchmaker, and logging setup; no test file is mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100