docs: add post-install next steps and stop-before-update instructions - #190
Open
TimeToBuildBob wants to merge 1 commit into
Open
TimeToBuildBob wants to merge 1 commit into
TimeToBuildBob wants to merge 1 commit into
Conversation
Closes ActivityWatch#94 (updating.rst should explain how to stop ActivityWatch before replacing files) and ActivityWatch#92 (getting-started should mention what to do after installing). - updating.rst: add 'Stop ActivityWatch before updating' section covering aw-qt tray Quit, systemd --user stop, pkill, macOS menu bar / killall, and Windows Task Manager, before the existing macOS-only note. - getting-started.rst: add 'Next steps after installing' section covering the browser extension (with store links), editor watchers (link to watchers.rst), setting up categories (web UI + categories.yaml), and where data lives (link to directories.rst). - docs#170 verified fixed on live site: docs.activitywatch.net search.html loads jquery.js and searchindex.js returns 200; the sphinxcontrib-jquery fix is in production. Git-Session-Id: c8ba
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
1 participant
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.
Summary
Closes #94 and #92 (and notes that #170 is fixed on live).
#94 —
updating.rsttold users to "replace the files" but never said stop ActivityWatch first. Overwriting the runningaw-serverbinary is exactly the failure mode users hit. The new Stop ActivityWatch before updating section covers every supported way to start it:aw-qttray Quit,systemctl --user stopfor the systemd path,pkill -f aw-qt/aw-serverfor the manual path, macOS menu-bar Quit /killall, and Windows tray Quit / Task Manager.#92 —
getting-started.rststopped at install. The new Next steps after installing section points users at the four high-leverage things to do next:aw-watcher-web) — Chrome/Edge/Brave and Firefox store links.watchers.rst.categories.yamlconfig file, with a pointer toconfiguration.rst.directories.rst.#170 — verified on the live site that the fix is in production:
docs.activitywatch.net/en/latest/search.htmlnow loads_static/jquery.jsandsearchindex.jsreturns HTTP 200 with content; the sphinxcontrib-jquery extension is doing its job. No code change needed, just a verification note.Why
Both #94 and #92 are 2020-vintage issues that have stayed open because the bar is "small but multi-section" docs work that's easy to defer. New users hit both within their first hour.
Test plan
make html(viauvx --with sphinx + extensions) builds with no new warnings on either modified file. (The pre-existing 124 warnings are all aw-core/aw-server/aw-client autodoc imports andautosectionlabelcollisions from headings that already exist in master — unrelated.)docs.activitywatch.netsearch verified: jQuery loads, searchindex.js serves.getting-started.htmlandupdating.htmlshortly.