Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions docs/LEGACY_FREEZE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Legacy freeze notice
description: Historical docs URL. The current first run is openadapt quickstart and openadapt flow.
canonical: https://docs.openadapt.ai/get-started/
redirect_to: /get-started/
hide:
- navigation
- toc
---

# Legacy freeze notice

This URL is historical. It described an older codebase freeze. The current first run is:

```bash
pip install openadapt
openadapt quickstart
```

That records a demonstration, compiles a program, and replays it. Continue at [Get started](/get-started/).

[Continue to Get started](/get-started/){ .md-button .md-button--primary }
15 changes: 15 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Architecture moved
description: The current compiler model lives under Concepts, not a package-first architecture page.
canonical: https://docs.openadapt.ai/concepts/
redirect_to: /concepts/
hide:
- navigation
- toc
---

# Architecture moved

The current compiler model is under [Concepts](/concepts/). OpenAdapt records a GUI workflow, compiles it, and replays the program. Start with [the demonstration compiler](/concepts/demonstration-compiler/) or the [product components](/ecosystem/) catalog.

[Continue to Concepts](/concepts/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: CLI moved
description: The current command surface is openadapt flow. See the CLI reference.
canonical: https://docs.openadapt.ai/reference/cli/
redirect_to: /reference/cli/
hide:
- navigation
- toc
---

# CLI moved

The current command surface is `openadapt flow`. Every verb is in the [openadapt flow CLI](/reference/cli/) reference.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the verbs for a first workflow. The local tutorial is on [Get started](/get-started/).

[Continue to the CLI reference](/reference/cli/){ .md-button .md-button--primary }
4 changes: 2 additions & 2 deletions docs/ecosystem/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Flow accepts its recording.

| Repository | Lifecycle | Public role |
|---|---|---|
| [openadapt-ml](https://github.com/OpenAdaptAI/openadapt-ml) | **Research** | Optional VLM training, inference, and demonstration-conditioning work. The healthy compiler path does not require it. |
| [openadapt-evals](https://github.com/OpenAdaptAI/openadapt-evals) | **Research** | GUI workflow and demonstration-conditioning evaluation infrastructure. |
| [openadapt-ml](https://github.com/OpenAdaptAI/openadapt-ml) | **Research** | Optional model-training research. Recording, compiling, and replaying a workflow does not use it. |
| [openadapt-evals](https://github.com/OpenAdaptAI/openadapt-evals) | **Research** | GUI workflow evaluation research. The compiler path does not depend on it. |
| [openadapt-grounding](https://github.com/OpenAdaptAI/openadapt-grounding) | **Research** | UI grounding mechanisms and model adapters. |
| [openadapt-retrieval](https://github.com/OpenAdaptAI/openadapt-retrieval) | **Research** | Demonstration retrieval mechanisms. |

Expand Down
22 changes: 22 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Getting started moved
description: Install OpenAdapt and run the current record, compile, replay tutorial.
canonical: https://docs.openadapt.ai/get-started/
redirect_to: /get-started/
hide:
- navigation
- toc
---

# Getting started moved

This URL is from an older docs tree. Start at [Get started](/get-started/).

```bash
pip install openadapt
openadapt quickstart
```

`openadapt quickstart` records a demonstration, compiles it, and replays the program. For your own app, use `openadapt flow record`, `compile`, and `replay`.

[Continue to Get started](/get-started/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Installation moved
description: Install OpenAdapt with pip, then run the current tutorial.
canonical: https://docs.openadapt.ai/get-started/
redirect_to: /get-started/
hide:
- navigation
- toc
---

# Installation moved

Install the current package, then run the tutorial:

```bash
pip install openadapt
openadapt quickstart
```

The same `openadapt` command drives `openadapt flow record`, `compile`, and `replay`. Details are on [Get started](/get-started/).

[Continue to Get started](/get-started/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/getting-started/permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Permissions moved
description: Grant screen recording and accessibility permissions in the Desktop install guide.
canonical: https://docs.openadapt.ai/desktop/install/
redirect_to: /desktop/install/
hide:
- navigation
- toc
---

# Permissions moved

OS permission steps now live in [Desktop app: install and first run](/desktop/install/). Grant Screen Recording and Accessibility before you record, or the capture comes out blank.

The command-line first run does not need those permissions:

```bash
pip install openadapt
openadapt quickstart
```

[Continue to the Desktop install guide](/desktop/install/){ .md-button .md-button--primary }
23 changes: 17 additions & 6 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quick Start moved
description: The current OpenAdapt quickstart uses the deterministic demonstration compiler.
description: Record a GUI workflow, compile it, and replay the program with openadapt flow.
canonical: https://docs.openadapt.ai/get-started/
redirect_to: /get-started/
hide:
Expand All @@ -10,10 +10,21 @@ hide:

# Quick Start moved

The current quickstart is at [Get started](/get-started/).
The current first run is at [Get started](/get-started/).

It uses the canonical `openadapt quickstart` command to record, compile, check,
and replay a bundled synthetic workflow locally. It does not use the legacy
model-training path.
```bash
pip install openadapt
openadapt quickstart
```

[Continue to the current quickstart →](/get-started/){ .md-button .md-button--primary }
That records a bundled demonstration, compiles a program, and replays it locally. A healthy run makes no model API call.

To record your own application:

```bash
openadapt flow record --backend web --url https://your.app --out rec
openadapt flow compile rec --out bundle --name my-task
openadapt flow replay bundle --url https://your.app --headed
```

[Continue to Get started](/get-started/){ .md-button .md-button--primary }
20 changes: 20 additions & 0 deletions docs/legacy/freeze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Legacy freeze notice
description: Historical docs URL. The current first run is openadapt quickstart and openadapt flow.
canonical: https://docs.openadapt.ai/get-started/
redirect_to: /get-started/
hide:
- navigation
- toc
---

# Legacy freeze notice

This URL is historical. The current product compiles a demonstrated workflow into a program you can inspect and replay:

```bash
pip install openadapt
openadapt quickstart
```

[Continue to Get started](/get-started/){ .md-button .md-button--primary }
2 changes: 1 addition & 1 deletion docs/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> Official documentation for OpenAdapt, an open-source demonstration compiler for repeated GUI work. Record a GUI workflow once and compile it into deterministic replay: healthy runs are local and make no generative-model API calls; under UI drift the runtime re-resolves from retained evidence, proposes governed repairs, accepts human teaching, or halts rather than guess. MIT licensed.

## Get started
- [Get started](https://docs.openadapt.ai/get-started/): Run `pip install openadapt`, then `openadapt quickstart` for a complete local, effect-verified tutorial
- [Get started](https://docs.openadapt.ai/get-started/): Run `pip install openadapt`, then `openadapt quickstart` for a complete local, effect-verified tutorial. The current CLI is `openadapt flow record`, `compile`, `replay`. Older `/getting-started/` and package-mirror URLs redirect here.
- [Qualification evidence](https://docs.openadapt.ai/get-started/what-works-today/): Accepted substrate results, exact environments, and deployment boundaries
- [Your first workflow](https://docs.openadapt.ai/get-started/first-workflow/): Install the base package, then record, compile, lint, replay, and read the report on your own web app
- [What you get](https://docs.openadapt.ai/get-started/what-you-get/): The workflow bundle, the run report, and what each artifact is for
Expand Down
22 changes: 22 additions & 0 deletions docs/packages/capture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: openadapt-capture documentation moved
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# openadapt-capture documentation moved

Native capture is a product component. Drive it through `openadapt flow record` on a native, RDP, or Citrix backend.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/packages/evals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: openadapt-evals is Research
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# openadapt-evals is Research

This repository is Research evaluation infrastructure. The compiler path does not depend on it.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/packages/grounding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: openadapt-grounding is Research
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# openadapt-grounding is Research

This repository is Research. Recording, compiling, and replaying a workflow does not use it.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/packages/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Package catalog moved
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# Package catalog moved

Package pages from the older docs tree now live in one catalog.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/packages/ml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: openadapt-ml is Research
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# openadapt-ml is Research

This repository is Research. It is not required to record, compile, or replay a workflow.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
9 changes: 5 additions & 4 deletions docs/packages/openadapt-agent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: openadapt-agent documentation moved
description: OpenAdapt package documentation now lives in the canonical product and component guide.
description: Agent is a governed bridge to exact Flow bundles. The current command is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
Expand All @@ -10,7 +10,8 @@ hide:

# openadapt-agent documentation moved

The current product and component guide lives at
[Package and repository lifecycle](/ecosystem/).
Agent is a governed bridge from MCP clients and Agent Skills to exact Flow bundles. It does not replace `openadapt flow record`, `compile`, and `replay`.

[Continue to the current guide →](/ecosystem/){ .md-button .md-button--primary }
See the [product catalog](/ecosystem/).

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
22 changes: 22 additions & 0 deletions docs/packages/openadapt-bootstrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: openadapt-bootstrap is Research
description: OpenAdapt package documentation now lives in the product and component guide. The current CLI is openadapt flow.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
- navigation
- toc
---

# openadapt-bootstrap is Research

This repository is Research. It is not required to record, compile, or replay a workflow.

```bash
pip install openadapt
openadapt flow --help
```

Record, compile, and replay are the current verbs. See [Get started](/get-started/) for the first run, or the [product components](/ecosystem/) catalog for how the packages fit.

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
9 changes: 5 additions & 4 deletions docs/packages/openadapt-capture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: openadapt-capture documentation moved
description: OpenAdapt package documentation now lives in the canonical product and component guide.
description: Native capture feeds openadapt flow. The current command is openadapt flow record.
canonical: https://docs.openadapt.ai/ecosystem/
redirect_to: /ecosystem/
hide:
Expand All @@ -10,7 +10,8 @@ hide:

# openadapt-capture documentation moved

The current product and component guide lives at
[Package and repository lifecycle](/ecosystem/).
Native screen, mouse, and keyboard capture is a product component. You reach it through `openadapt flow record` on a native, RDP, or Citrix backend, or through Desktop. The extra is `openadapt[capture,...]` when you install a native driver.

[Continue to the current guide →](/ecosystem/){ .md-button .md-button--primary }
See the [product catalog](/ecosystem/) and [Get started](/get-started/).

[Continue to the current guide](/ecosystem/){ .md-button .md-button--primary }
Loading