docs: update README for installation and development build instructions#161
Merged
ErikBjare merged 2 commits intoActivityWatch:masterfrom Feb 21, 2025
Merged
docs: update README for installation and development build instructions#161ErikBjare merged 2 commits intoActivityWatch:masterfrom
ErikBjare merged 2 commits intoActivityWatch:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 51e2e74 in 2 minutes and 1 seconds
More details
- Looked at
125lines of code in1files - Skipped
0files when reviewing. - Skipped posting
7drafted comments based on config settings.
1. README.md:61
- Draft comment:
Good update: using 'git clone --recurse-submodules' directly initializes the repository, resolving the previous Git init issue. - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%
None
2. README.md:53
- Draft comment:
Clarify the Node.js version requirement (23 or higher); consider if using an LTS version might be more accessible for users. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50%
The comment raises a valid point about using LTS versions being more accessible, but without knowing the actual minimum Node.js version requirements of the build system or dependencies, this suggestion could be incorrect. We don't have evidence that an LTS version would actually work. The current requirement of Node.js 23+ was likely chosen for a specific reason.
I might be too cautious - suggesting LTS versions is generally good practice and could help users avoid issues with bleeding-edge Node versions.
Without understanding the technical requirements that led to specifying Node.js 23+, suggesting a change to LTS could lead to build failures or other issues.
The comment should be deleted as it makes assumptions about version compatibility without clear evidence that an LTS version would actually work.
3. README.md:30
- Draft comment:
The Firefox Enterprise Policy section might need further clarification on its applicability and configuration steps for users (e.g., corporate vs personal use). - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%
This comment is purely informative and suggests clarifying documentation, which is not within the scope of code review comments. It doesn't provide a specific code suggestion or highlight a potential issue with the code itself.
4. README.md:63
- Draft comment:
Using 'git clone --recurse-submodules' now properly initializes the repo, addressing the previous 'git init' issue. Optionally, note how to update submodules for existing clones. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%
None
5. README.md:30
- Draft comment:
Consider clarifying the Firefox Enterprise Policy section—explain its applicability (e.g. enterprise/corporate scenarios) and guide less technical users on where to adjust these settings. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%
None
6. README.md:55
- Draft comment:
Verify the Node.js version requirement ('Node.js (23 or higher)'). This seems unusually high compared to common LTS versions. - Reason this comment was not posted:
Confidence changes required:33%<= threshold50%
None
7. README.md:8
- Draft comment:
The separation into 'Official Releases' and 'Development Build' sections significantly improves clarity for users—nice work! - Reason this comment was not posted:
Confidence changes required:0%<= threshold50%
None
Workflow ID: wflow_rYE5IFJtVYz2cE4p
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Member
|
Very nice, thanks! |
Infiniti151
pushed a commit
to Infiniti151/aw-watcher-web
that referenced
this pull request
Feb 21, 2026
…ns (ActivityWatch#161) * docs: update README for installation and development build instructions * Lint
This file contains hidden or 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
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.
Important
Updates
README.mdwith detailed installation and development build instructions, including prerequisites, build steps, and installation for Chrome and Firefox.README.md.This description was created by
for 51e2e74. It will automatically update as commits are pushed.