The docs are a user guide, with a screenshot of each part of the app #23

Merged

alex merged 1 commit from docs-user-guide into main 2026-10-29 20:47:01 +01:00

Conversation 0 Commits 1 Files changed 74 +804 -122

alex commented 2026-10-29 20:46:49 +01:00

Owner

Copy link

What this does

• Every guide page is rewritten for people using Overlight: short sections, tables for the shortcuts and the modes, and a screenshot beside each feature. Pages link to the previous and next one.
• docs/README.md is a front page: a "Start here" path, then a thumbnail and a summary per topic.
• A theme gallery: all 25 themes in docs/guide/themes.md, each one image split diagonally between its light and dark side, with its description and motion.
• The README links into the guide: each feature section ends with a link to its page, and the themes section shows three of the split images linking to the gallery.

Screenshots

61 new images: 36 in docs/images/guide (setup steps, tour, launcher, menus, dialogs, task tabs, reports, every settings section) and 25 in docs/images/themes; docs/images is 9.6 MB in all. They come from a throwaway instance with demo data. Six of them (launcher, notifications, shortcuts, the project menu and edit dialog) are lower-resolution JPEGs taken in a real browser, because headless Chrome would not open those menus.

Accuracy

• Nothing the old pages said is dropped: the agent's tool names, the skill folders and projects.workflow are still there.
• Corrected where the docs had drifted from the app: Discord is under Settings › Plugins, desktop notifications under Settings › Notifications, trackers plug in through the plugin SDK, and 1–6 move a card between columns.
• Every link, image and in-page anchor in the README and the docs resolves, and every image in docs/images is used.

Docs only; no code changes.

🤖 Generated with Claude Code

## What this does - **Every guide page is rewritten for people using Overlight**: short sections, tables for the shortcuts and the modes, and a screenshot beside each feature. Pages link to the previous and next one. - **`docs/README.md` is a front page**: a "Start here" path, then a thumbnail and a summary per topic. - **A theme gallery**: all 25 themes in `docs/guide/themes.md`, each one image split diagonally between its light and dark side, with its description and motion. - **The README links into the guide**: each feature section ends with a link to its page, and the themes section shows three of the split images linking to the gallery. ## Screenshots 61 new images: 36 in `docs/images/guide` (setup steps, tour, launcher, menus, dialogs, task tabs, reports, every settings section) and 25 in `docs/images/themes`; `docs/images` is 9.6 MB in all. They come from a throwaway instance with demo data. Six of them (launcher, notifications, shortcuts, the project menu and edit dialog) are lower-resolution JPEGs taken in a real browser, because headless Chrome would not open those menus. ## Accuracy - Nothing the old pages said is dropped: the agent's tool names, the skill folders and `projects.workflow` are still there. - Corrected where the docs had drifted from the app: Discord is under Settings › Plugins, desktop notifications under Settings › Notifications, trackers plug in through the plugin SDK, and `1`–`6` move a card between columns. - Every link, image and in-page anchor in the README and the docs resolves, and every image in `docs/images` is used. Docs only; no code changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

alex added 1 commit 2026-10-29 20:46:50 +01:00

The docs are a user guide, with a screenshot of each part of the app ... 7f9103e7a4

Every page in docs/guide is rewritten for someone using Overlight: short
sections, tables for the shortcuts and the modes, and a screenshot beside
each feature (36 new ones in docs/images/guide: the setup steps, the tour,
the launcher, menus, dialogs, task tabs, reports and every settings
section). Pages link to the previous and next one, and docs/README.md is a
front page with a "Start here" path and a thumbnail per topic.

The themes page is a gallery of all twenty-five, each one image split
diagonally between its light and dark side (docs/images/themes), with the
description and motion the old reference gave it.

Details the old pages had are kept (the agent's tool names, the skill
folders, projects.workflow) and a few that had drifted are corrected:
Discord is under Settings › Plugins, desktop notifications under Settings ›
Notifications, trackers plug in through the plugin SDK, and 1–6 move a card
between columns. The README ends each feature section with a link to its
page, and its themes section links three of the split images to the gallery.

The screenshots come from a throwaway instance with demo data; six of them
(the launcher, notifications, shortcuts, the project menu and edit dialog)
were taken in a real browser, as headless Chrome would not open those menus.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

alex merged commit 777bf842ae into main 2026-10-29 20:47:01 +01:00

alex referenced this pull request from a commit 2026-10-29 20:47:03 +01:00

Merge pull request 'The docs are a user guide, with a screenshot of each part of the app' (#23) from docs-user-guide into main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

Overlight/App!23

No description provided.