Document modules for supporting Wayland more clearly

[Game4Move78]

The following information is easy to miss:

• Wayland not yet supported by aw-watcher-window or aw-watcher-afk.
• Wayland (Posh, Sway) is supported by aw-watcher-wayland (window+idle).
• Wayland (Sway, Hyprland, KDE, GNOME, and X11) is supported by awatcher (window+idle).

Wayland users are likely to burn themselves once or twice before realising the default watchers do not support their system. Currently this is hinted with (X11 only) in the "Window Watchers" section of watchers.rst, which users may not think to check, so I added a note on the "Getting Started" and "Installing from Source" pages. Information that aw-watcher-window-wayland doesn't work on KDE or Gnome is also not clear, so I added a list of the supported DE in brackets.

Also I linked to "building from source" as an installation option. At the moment it is only linked to from "Usage", which is less intuitive.

---

Important

Improves documentation clarity on Wayland support and installation options in ActivityWatch.

• Documentation Updates:
  • Added notes in getting-started.rst and installing-from-source.rst about Wayland not being supported by default watchers, with links to Wayland-compatible watchers.
  • Updated watchers.rst to clarify default watcher support (Windows, macOS, Linux X11) and list Wayland-compatible watchers (aw-watcher-window-wayland, 2e3s/awatcher).
• Installation Guidance:
  • Linked "building from source" as an installation option in getting-started.rst for better visibility.

^{This description was created by for 48dd40c. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 48dd40c in 1 minute and 13 seconds

More details

• Looked at 79 lines of code in 3 files
• Skipped 0 files when reviewing.
• Skipped posting 9 drafted comments based on config settings.

1. src/getting-started.rst:56

• Draft comment:
  Good addition of a Wayland note. Consider clarifying which replacement modules to use (or linking to a section detailing supported desktop environments) for extra clarity.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable:
  The note is already concise and links to detailed information. The suggestion to add more detail here would make the note longer and potentially duplicate information that's already in the linked section. The current format follows good documentation practices - brief warning with a link to details.
  The comment might have a point about user experience - some users prefer having immediate access to key information without following links.
  Documentation best practices favor concise, well-organized content with clear navigation over duplicating information. The current structure achieves this.
  The comment should be deleted as it suggests a change that would likely make the documentation less maintainable without significant benefit.

2. src/installing-from-source.rst:32

• Draft comment:
  Useful note for Wayland users. It might help to emphasize that the default X11 watchers won't work on Wayland and to refer users to the specific replacement module info.
• Reason this comment was not posted:
  Marked as duplicate.

3. src/watchers.rst:24

• Draft comment:
  The update listing Wayland support is clearer now. Consider ensuring consistent naming for desktop environments (e.g., listing supported ones explicitly) so users understand which DEs are supported and which are not.
• Reason this comment was not posted:
  Marked as duplicate.

4. src/getting-started.rst:36

• Draft comment:
  Good addition of the 'Source' tab to highlight building from source.
• Reason this comment was not posted:
  Confidence changes required: 0%
  None

5. src/getting-started.rst:56

• Draft comment:
  Clear note for Wayland users; consider optionally specifying that the default watchers (aw-watcher-afk and aw-watcher-window) are X11-only.
• Reason this comment was not posted:
  Confidence changes required: 33%
  None

6. src/installing-from-source.rst:31

• Draft comment:
  Consistent note for Wayland systems helps users during the source build process.
• Reason this comment was not posted:
  Confidence changes required: 0%
  None

7. src/watchers.rst:6

• Draft comment:
  Explicitly mentioning '(X11 only)' for the default watchers is a useful clarification for non-X11 users.
• Reason this comment was not posted:
  Confidence changes required: 0%
  None

8. src/watchers.rst:24

• Draft comment:
  The updated description for aw-watcher-window-wayland clearly indicates its support (Posh, Sway). Consider noting any limitations if applicable.
• Reason this comment was not posted:
  Confidence changes required: 33%
  None

9. src/watchers.rst:25

• Draft comment:
  Listing the supported desktop environments for 2e3s/awatcher is very helpful. For consistency, you might consider listing them in alphabetical order.
• Reason this comment was not posted:
  Confidence changes required: 33%
  None

Workflow ID: wflow_XZYu1mCGLfsFgsmZ

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.