Skip to content

Commit 995fffe

Browse files
authored
docs: update documentation based on recent changes (anomalyco#1294)
1 parent d6480b8 commit 995fffe

4 files changed

Lines changed: 33 additions & 3 deletions

File tree

PRODUCT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ Where are workflow hosted:
3333
- Remote via a OpenWork Host (CLI or desktop)
3434
- Remote on OpenWork Cloud (via Den sandbox workers)
3535

36+
## Current OpenWork Cloud flow
37+
38+
- Users can sign in with the standard web auth providers or accept an org invite through the hosted join flow.
39+
- Invite signup keeps the invited email fixed, verifies the user by email code, and then drops them into the org join path.
40+
- Cloud workers are a paid flow: users complete checkout before they can launch hosted workers.
41+
- After a worker is ready, the user connects from the OpenWork app with `Add a worker` -> `Connect remote`, or opens the generated deep link directly.
42+
43+
## Team distribution
44+
45+
- Organizations can publish shared skill hubs so members discover approved skills from one managed place instead of collecting local-only installs by hand.
46+
3647
## Actors
3748
Bob IT guy makes the config.
3849
Susan the accountant consumes the config.

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ OpenWork is designed around the idea that you can easily ship your agentic workf
2222

2323
## Quick start
2424

25-
Download the correct version in [here](https://openworklabs.com/download), in the latest [releases](https://github.com/different-ai/openwork/releases) or install from source below.
25+
Download the desktop app from [openworklabs.com/download](https://openworklabs.com/download), grab the latest [GitHub release](https://github.com/different-ai/openwork/releases), or install from source below.
26+
27+
- macOS and Linux downloads are available directly.
28+
- Windows access is currently handled through the paid support plan on [openworklabs.com/pricing#windows-support](https://openworklabs.com/pricing#windows-support).
29+
- Hosted OpenWork Cloud workers are launched from the web app after checkout, then connected from the desktop app via `Add a worker` -> `Connect remote`.
2630

2731
## Why
2832

@@ -44,6 +48,7 @@ OpenWork is designed to be:
4448
- **Execution plan**: render OpenCode todos as a timeline.
4549
- **Permissions**: surface permission requests and reply (allow once / always / deny).
4650
- **Templates**: save and re-run common workflows (stored locally).
51+
- **Debug exports**: copy or export the runtime debug report and developer log stream from Settings -> Debug when you need to file a bug.
4752
- **Skills manager**:
4853
- list installed `.opencode/skills` folders
4954
- import a local skill folder into `.opencode/skills/<skill-name>`
@@ -173,6 +178,8 @@ pnpm test:e2e
173178

174179
## Troubleshooting
175180

181+
If you need to report a desktop or session bug, open Settings -> Debug and export both the runtime debug report and developer logs before filing an issue.
182+
176183
### Linux / Wayland (Hyprland)
177184

178185
If OpenWork crashes on launch with WebKitGTK errors like `Failed to create GBM buffer`, disable dmabuf or compositing before launch. Try one of the following environment flags.

SUPPORT.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Use the right channel to get faster help:
1313

1414
- Search existing issues to avoid duplicates.
1515
- Include exact OpenWork/OpenCode versions, OS, and reproduction steps.
16-
- Add logs/screenshots when possible.
16+
- For desktop, worker, or session bugs, open Settings -> Debug and include both:
17+
- the runtime debug report
18+
- the developer log export
19+
- Add screenshots when they help explain the flow or failure state.
1720

1821
## Maintainer triage
1922

ee/apps/den-web/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,20 @@ Frontend for `app.openworklabs.com`.
55
## What it does
66

77
- Signs up / signs in users against Den service auth.
8+
- Handles invited-org signup flows where the invited email stays locked and the user verifies access before joining.
89
- Launches cloud workers via `POST /v1/workers`.
9-
- Handles paywall responses (`402 payment_required`) and shows Polar checkout links.
10+
- Handles paywall responses (`402 payment_required`), routes users through Polar checkout, and only enables worker launch after purchase.
11+
- Offers desktop handoff actions so users can open the generated worker directly in OpenWork or copy the connect credentials manually.
1012
- Uses a Next.js proxy route (`/api/den/*`) to reach `api.openworklabs.com` without browser CORS issues.
1113
- Uses a same-origin auth proxy (`/api/auth/*`) so GitHub OAuth callbacks can land on `app.openworklabs.com`.
1214

15+
## Current hosted user flow
16+
17+
1. Sign in with a standard provider or accept an org invite.
18+
2. If the org requires billing, complete checkout before launching a worker.
19+
3. Launch the worker from the cloud dashboard.
20+
4. Open the worker in the desktop app with the provided deep link, or copy the URL/token into `Connect remote` manually.
21+
1322
## Local development
1423

1524
1. Install workspace deps from repo root:

0 commit comments

Comments
 (0)