Skip to content

docs: update directories for aw-server-rust and add Edit on GitHub links#166

Merged
ErikBjare merged 2 commits intoActivityWatch:masterfrom
TimeToBuildBob:fix/docs-updates
Feb 27, 2026
Merged

docs: update directories for aw-server-rust and add Edit on GitHub links#166
ErikBjare merged 2 commits intoActivityWatch:masterfrom
TimeToBuildBob:fix/docs-updates

Conversation

@TimeToBuildBob
Copy link
Contributor

@TimeToBuildBob TimeToBuildBob commented Feb 27, 2026

Summary

  • Update directories.rst with correct aw-server-rust paths — since v0.12 the default server is aw-server-rust, but the docs still referenced old Python server paths
  • Fill in cache directory paths for Windows and macOS (previously TODO)
  • Note the per-component subdirectory convention (each component gets its own subdirectory)
  • Update appdirs-rs crate reference to dirs (which aw-server-rust actually uses)
  • Add html_context to conf.py for "Edit on GitHub" links in the RTD theme

Fixes #155, fixes #158.

Test plan

  • Verify ReadTheDocs build passes
  • Check directories page renders correctly
  • Check "Edit on GitHub" link appears on pages

Important

Update documentation for aw-server-rust paths and add "Edit on GitHub" links.

  • Documentation Updates:
    • Update directories.rst to reflect aw-server-rust paths for data, config, logs, and cache directories on Windows, macOS, and Linux.
    • Note subdirectory convention for each component in directories.rst.
    • Update reference from appdirs-rs to dirs crate in directories.rst.
  • Configuration:
    • Add html_context in conf.py for "Edit on GitHub" links in the RTD theme.

This description was created by Ellipsis for dac4122. You can customize this summary. It will automatically update as commits are pushed.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to dac4122 in 6 seconds. Click for details.
  • Reviewed 88 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

Workflow ID: wflow_BtTTOddg9CB7e5ha

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@ErikBjare
Copy link
Member

@TimeToBuildBob See the review comments here

- Update directories.rst with correct aw-server-rust paths (fixes ActivityWatch#155)
- Fill in previously-TODO cache paths for Windows/macOS
- Note per-component subdirectory convention
- Update appdirs-rs reference to dirs crate
- Add html_context for "Edit on GitHub" links in RTD theme (fixes ActivityWatch#158)
…ory examples

Address review feedback from Erik:
- Remove false claim that aw-server-rust became default in v0.12
  (it will be default in v0.14.0 via aw-tauri bundle)
- Simplify subdirectory note - examples are redundant given the paths below
@ErikBjare ErikBjare merged commit df9eb3e into ActivityWatch:master Feb 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to GitHub docs repo pages Directories page is outdated

2 participants