Skip to content

docs: automated documentation updates #1294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jcllobet merged 1 commit into from
Apr 2, 2026
Merged

docs: automated documentation updates #1294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions PRODUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ Where are workflow hosted:
- Remote via a OpenWork Host (CLI or desktop)
- Remote on OpenWork Cloud (via Den sandbox workers)

## Current OpenWork Cloud flow

- Users can sign in with the standard web auth providers or accept an org invite through the hosted join flow.
- Invite signup keeps the invited email fixed, verifies the user by email code, and then drops them into the org join path.
- Cloud workers are a paid flow: users complete checkout before they can launch hosted workers.
- 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.

## Team distribution

- Organizations can publish shared skill hubs so members discover approved skills from one managed place instead of collecting local-only installs by hand.

## Actors
Bob IT guy makes the config.
Susan the accountant consumes the config.
Expand Down
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ OpenWork is designed around the idea that you can easily ship your agentic workf

## Quick start

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.
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.

- macOS and Linux downloads are available directly.
- Windows access is currently handled through the paid support plan on [openworklabs.com/pricing#windows-support](https://openworklabs.com/pricing#windows-support).
- Hosted OpenWork Cloud workers are launched from the web app after checkout, then connected from the desktop app via `Add a worker` -> `Connect remote`.

## Why

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

## Troubleshooting

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.

### Linux / Wayland (Hyprland)

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.
Expand Down
5 changes: 4 additions & 1 deletion SUPPORT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Use the right channel to get faster help:

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

## Maintainer triage

Expand Down
11 changes: 10 additions & 1 deletion ee/apps/den-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,20 @@ Frontend for `app.openworklabs.com`.
## What it does

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

## Current hosted user flow

1. Sign in with a standard provider or accept an org invite.
2. If the org requires billing, complete checkout before launching a worker.
3. Launch the worker from the cloud dashboard.
4. Open the worker in the desktop app with the provided deep link, or copy the URL/token into `Connect remote` manually.

## Local development

1. Install workspace deps from repo root:
Expand Down
Loading