From dd768a2f8edfa03d53bc19d55658770f519a7fd4 Mon Sep 17 00:00:00 2001 From: Richard Abrich Date: Fri, 17 Jul 2026 16:13:19 -0400 Subject: [PATCH] docs: add lifecycle status banner pointing to openadapt-flow Aligns this repository's front door with the org-wide product narrative: the demonstration compiler (openadapt-flow) installed via the OpenAdapt launcher. Status label matches the public repository lifecycle registry in OpenAdaptAI/.github. Co-Authored-By: Claude Fable 5 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d83fed0..e170715 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # openadapt-retrieval +> [!IMPORTANT] +> **Status: Research — not required by the product.** This package explores +> multimodal demonstration retrieval for model-conditioned agents. It is not +> required to record, compile, or replay a workflow. +> +> The OpenAdapt product is the demonstration compiler, +> [`openadapt-flow`](https://github.com/OpenAdaptAI/openadapt-flow), installed +> via the [`OpenAdapt`](https://github.com/OpenAdaptAI/OpenAdapt) launcher +> (`pip install openadapt`): it compiles a demonstrated GUI workflow into a +> deterministic, locally executable program. Healthy runs make no model calls, +> and it halts instead of guessing when verification fails. Lifecycle labels for +> every repository are in the +> [repository lifecycle registry](https://github.com/OpenAdaptAI/.github/blob/main/REPOSITORY_LIFECYCLE.md). + [![Build Status](https://github.com/OpenAdaptAI/openadapt-retrieval/actions/workflows/publish.yml/badge.svg)](https://github.com/OpenAdaptAI/openadapt-retrieval/actions/workflows/publish.yml) [![PyPI version](https://img.shields.io/pypi/v/openadapt-retrieval.svg)](https://pypi.org/project/openadapt-retrieval/) [![Downloads](https://img.shields.io/pypi/dm/openadapt-retrieval.svg)](https://pypi.org/project/openadapt-retrieval/)