Skip to content

feat(faq): add user-facing FAQ entries and organize into sections#168

Open
TimeToBuildBob wants to merge 2 commits intoActivityWatch:masterfrom
TimeToBuildBob:faq-update
Open

feat(faq): add user-facing FAQ entries and organize into sections#168
TimeToBuildBob wants to merge 2 commits intoActivityWatch:masterfrom
TimeToBuildBob:faq-update

Conversation

@TimeToBuildBob
Copy link
Contributor

@TimeToBuildBob TimeToBuildBob commented Feb 28, 2026

Summary

Adds user-facing FAQ entries to the Sphinx docs FAQ page and organizes it into General and Technical sections.

New entries (General section):

  • What is ActivityWatch?
  • Is ActivityWatch really free?
  • What platforms does ActivityWatch support?
  • Does ActivityWatch track my data privately?
  • How does ActivityWatch compare to RescueTime?
  • Can I extend ActivityWatch with custom tracking?

Changes to existing content:

  • "Where is my data stored?" moved to General section with a note about no cloud
  • All existing technical entries preserved in a new Technical section
  • Heading levels adjusted (~~~ instead of ---) for proper section hierarchy

Context:

Test plan

  • Verify Sphinx builds without warnings
  • Check all internal refs (:ref:) resolve correctly
  • Verify external links work
  • Review content for accuracy

Important

Adds new user-facing FAQ entries and reorganizes existing content into General and Technical sections in src/faq.rst.

  • New FAQ Entries:
    • Added to General section in src/faq.rst: "What is ActivityWatch?", "Is ActivityWatch really free?", "What platforms does ActivityWatch support?", "Does ActivityWatch track my data privately?", "How does ActivityWatch compare to RescueTime?", "Can I extend ActivityWatch with custom tracking?".
  • Reorganization:
    • Moved "Where is my data stored?" to General section with added note about no cloud storage.
    • Preserved all existing technical entries in a new Technical section.
    • Adjusted heading levels from --- to ~~~ for proper section hierarchy.
  • Context:

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

Add general FAQ entries from the website (activitywatch.github.io#42):
- What is ActivityWatch?
- Is it really free?
- Platform support
- Privacy/data storage
- RescueTime comparison (with link to detailed blog post)
- Custom tracking/extensibility

Organize into General and Technical sections for better navigation.
Existing technical entries preserved as-is in the Technical section.

Follow-up from activitywatch.github.io#42 discussion per @ErikBjare request.
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 148fd68 in 7 seconds. Click for details.
  • Reviewed 126 lines of code in 1 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_bc3xYoewWzoU4YmD

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

@greptile-apps
Copy link

greptile-apps bot commented Feb 28, 2026

Greptile Summary

Adds comprehensive user-facing FAQ entries covering ActivityWatch basics (what it is, pricing, platform support, privacy, RescueTime comparison, and extensibility) and reorganizes the FAQ page into General and Technical sections. The new content aligns with the website homepage FAQ for consistency and addresses common questions from potential users.

  • New General section with 6 entries answering basic questions about ActivityWatch
  • "Where is my data stored?" moved from top-level to General section with added cloud note
  • All existing technical questions preserved in new Technical section
  • Heading hierarchy adjusted properly using ~~~ for subsections
  • One broken Sphinx reference needs fixing (:ref:Examples )

Confidence Score: 4/5

  • Safe to merge after fixing the broken Sphinx reference
  • Documentation-only change with well-written, accurate content and proper reorganization. One syntax issue with a Sphinx reference will cause a build warning but won't break the docs
  • Fix the Sphinx reference in src/faq.rst:48 before merging

Important Files Changed

Filename Overview
src/faq.rst Added 6 user-facing FAQ entries in General section and reorganized existing technical questions; has one broken Sphinx reference

Last reviewed commit: 148fd68

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
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.

2 participants