Skip to content

Commit b3210e5

Browse files
committed
docs: added basic staging docs, added 'meta' toctree
1 parent 650e23a commit b3210e5

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

src/index.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,13 @@ Table of contents
2222
features
2323
watchers
2424
faq
25-
history
25+
syncing
2626
migrating
2727
running-on-gnome
2828
remote-server
2929
updating
3030
uninstalling
3131

32-
3332
.. _dev-docs:
3433
.. toctree::
3534
:maxdepth: 3
@@ -45,12 +44,18 @@ Table of contents
4544
examples/extending
4645
api
4746
security
48-
privacy
4947
server-compare
5048
development
5149
forking
52-
changelog
5350

51+
.. _meta-docs:
52+
.. toctree::
53+
:maxdepth: 3
54+
:caption: Meta
55+
56+
privacy
57+
history
58+
changelog
5459

5560
Indices and tables
5661
------------------

src/remote-server.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ But then how do I get all my data in one place?
3535

3636
Your options are:
3737

38+
- Using the :docs:`syncing` feature
3839
- Manually export & import buckets (recommended)
39-
- Wait for syncing to get implemented
4040
- Find other time tracking software that's more suitable for your usecase
4141
- Keep reading...
4242

src/syncing.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Syncing
2+
=======
3+
4+
.. note::
5+
6+
This feature is currently in beta and may change in future releases.
7+
8+
ActivityWatch has basic support for syncing your data across multiple devices using the ``aw-sync`` module since ``v0.13.0``. It works by creating a "staging" database file in a device-specific folder in the sync directory (default is ``~/ActivityWatchSync``), which is then synced to the other devices using a file syncing tool of your choice (like Syncthing, rsync, Dropbox, or Google Drive). So ``aw-sync`` does itself send data over the network, but instead relies on you using a file syncing tool to do that.
9+
10+
Note that syncing is not available on Android, yet.
11+
12+
How to set up syncing
13+
---------------------
14+
15+
.. note::
16+
17+
We recommend you've switched to ``aw-server-rust`` before using the syncing feature, as it has better performance which will help with syncing large amounts of data. If you are still using the legacy ``aw-server`` (Python), you can find the documentation for switching to the Rust server in :docs:`migrating`.
18+
19+
For detailed instructions on how to use syncing, see the `aw-sync README <https://github.com/ActivityWatch/aw-server-rust/blob/master/aw-sync/README.md>`_.

0 commit comments

Comments
 (0)