From 76ce82d117ec03ee23490319fbc4985a0edc9283 Mon Sep 17 00:00:00 2001 From: Morgan Dean Date: Mon, 21 Jul 2025 15:28:55 -0700 Subject: [PATCH] Update docs content to reflect in-progress state. --- docs/content/docs/api/agent/0.2.0.mdx | 14 ------------- docs/content/docs/api/agent/index.mdx | 4 +++- .../docs/api/computer-server/index.mdx | 5 ++++- docs/content/docs/api/computer/index.mdx | 3 +++ docs/content/docs/api/core/index.mdx | 3 +++ docs/content/docs/api/index.mdx | 21 ++++++++++++++++++- docs/content/docs/api/lume/index.mdx | 13 +++++++++++- docs/content/docs/api/lumier/index.mdx | 3 +++ docs/content/docs/api/mc-server/index.mdx | 3 +++ docs/content/docs/api/som/index.mdx | 3 +++ 10 files changed, 54 insertions(+), 18 deletions(-) delete mode 100644 docs/content/docs/api/agent/0.2.0.mdx 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 0ebff6af..00000000 --- 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 44c654fc..95df81b3 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 94bc8987..fea2b12c 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 ba1873ff..f71da442 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 02fa22cd..bde0f48f 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 f005ab61..e3faef13 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. + + + + + } + href="https://github.com/trycua/cua/tree/main/libs"> + Visit the repository that contains all libraries. + diff --git a/docs/content/docs/api/lume/index.mdx b/docs/content/docs/api/lume/index.mdx index 2854d543..fb98353b 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 371ed4a4..22d1f5cf 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 4af8c5ea..a63036b5 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 4ffee904..ee8b2e1e 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