Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

Update docs content to reflect in-progress state.

Morgan Dean76ce82d117ec
diff --git a/docs/content/docs/api/agent/0.2.0.mdx b/docs/content/docs/api/agent/0.2.0.mdx
deleted file mode 100644
index 0ebff6afea..0000000000
--- a/docs/content/docs/api/agent/0.2.0.mdx
+++ /dev/null
@@ -1,14 +0,0 @@
----
-title: v0.2.0
-description: Api reference for version 0.2.0 of the agent library
----
-
-The Agent API reference documentation is currently under development.
-
-## Overview
-
-The Agent library provides programmatic interfaces for AI agent interactions.
-
-## API Documentation
-
-Coming soon.
diff --git a/docs/content/docs/api/agent/index.mdx b/docs/content/docs/api/agent/index.mdx
index 44c654fc9d..95df81b3a8 100644
--- a/docs/content/docs/api/agent/index.mdx
+++ b/docs/content/docs/api/agent/index.mdx
@@ -1,8 +1,10 @@
---
title: Agent
-description: Current api reference for the agent library
+description: Reference for the current version of the Agent library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The Agent API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/computer-server/index.mdx b/docs/content/docs/api/computer-server/index.mdx
index 94bc898764..fea2b12c14 100644
--- a/docs/content/docs/api/computer-server/index.mdx
+++ b/docs/content/docs/api/computer-server/index.mdx
@@ -1,7 +1,10 @@
---
-title: Computer
+title: Computer Server
+descrption: Reference for the current version of the Computer Server library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The Computer Server API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/computer/index.mdx b/docs/content/docs/api/computer/index.mdx
index ba1873ff39..f71da44260 100644
--- a/docs/content/docs/api/computer/index.mdx
+++ b/docs/content/docs/api/computer/index.mdx
@@ -1,7 +1,10 @@
---
title: Computer
+description: Reference for the current version of the Computer library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The Computer API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/core/index.mdx b/docs/content/docs/api/core/index.mdx
index 02fa22cd28..bde0f48fe5 100644
--- a/docs/content/docs/api/core/index.mdx
+++ b/docs/content/docs/api/core/index.mdx
@@ -1,7 +1,10 @@
---
title: Core
+description: Reference for the current version of the Core library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The Core API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/index.mdx b/docs/content/docs/api/index.mdx
index f005ab6125..e3faef13a8 100644
--- a/docs/content/docs/api/index.mdx
+++ b/docs/content/docs/api/index.mdx
@@ -1,5 +1,24 @@
---
title: API Reference
-description: This is where the api referece goes
+description: Explore API reference for Cua services and libraries.
icon: CodeXml
---
+
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
+Please note that the API Reference documenation is currently under construction. Some libraries will have limited documentation written, while others will have none.
+
+We're currently working on generated comprehensive classes and definitions for all libraries.
+
+If you need to find anything specific and it's not here, you can visit the repository below to browse implementations.
+
+<Card
+ title="Cua - GitHub"
+ icon={
+ <svg role="img" viewBox="0 0 24 24" fill="currentColor">
+ <path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path>
+ </svg>
+ }
+ href="https://github.com/trycua/cua/tree/main/libs">
+ Visit the repository that contains all libraries.
+</Card>
diff --git a/docs/content/docs/api/lume/index.mdx b/docs/content/docs/api/lume/index.mdx
index 2854d543f0..fb98353bf0 100644
--- a/docs/content/docs/api/lume/index.mdx
+++ b/docs/content/docs/api/lume/index.mdx
@@ -1,5 +1,16 @@
---
title: Lume
+description: Reference for the current version of the Lume CLI.
---
-Coming soon
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
+The Lume API reference documentation is currently under development.
+
+## Overview
+
+The Lume CLI provides command line tools for managing virtual machines with Lume.
+
+## API Documentation
+
+Coming soon.
diff --git a/docs/content/docs/api/lumier/index.mdx b/docs/content/docs/api/lumier/index.mdx
index 371ed4a46f..22d1f5cf8e 100644
--- a/docs/content/docs/api/lumier/index.mdx
+++ b/docs/content/docs/api/lumier/index.mdx
@@ -1,7 +1,10 @@
---
title: Lumier
+description: Reference for the current version of the Lumeir library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The Lumier API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/mc-server/index.mdx b/docs/content/docs/api/mc-server/index.mdx
index 4af8c5ead4..a63036b595 100644
--- a/docs/content/docs/api/mc-server/index.mdx
+++ b/docs/content/docs/api/mc-server/index.mdx
@@ -1,7 +1,10 @@
---
title: MCP Server
+description: Reference for the current version of the MCP Server library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The MCP Server API reference documentation is currently under development.
## Overview
diff --git a/docs/content/docs/api/som/index.mdx b/docs/content/docs/api/som/index.mdx
index 4ffee9046f..ee8b2e1e5f 100644
--- a/docs/content/docs/api/som/index.mdx
+++ b/docs/content/docs/api/som/index.mdx
@@ -1,7 +1,10 @@
---
title: Set-of-Mark
+description: Reference for the current version of the Set-of-Mark library.
---
+## ⚠️ 🚧 Under Construction 🚧 ⚠️
+
The SOM (Set-of-Mark) API reference documentation is currently under development.
## Overview