diff --git a/docs/content/docs/api/index.mdx b/docs/content/docs/api/index.mdx new file mode 100644 index 00000000..bab35809 --- /dev/null +++ b/docs/content/docs/api/index.mdx @@ -0,0 +1,4 @@ +--- +title: API Reference Home +description: API Reference +--- diff --git a/docs/content/docs/api/meta.json b/docs/content/docs/api/meta.json new file mode 100644 index 00000000..0bd47d9d --- /dev/null +++ b/docs/content/docs/api/meta.json @@ -0,0 +1,5 @@ +{ + "title": "API Reference", + "description": "API Reference", + "root": true +} \ No newline at end of file diff --git a/docs/content/docs/cloud/index.mdx b/docs/content/docs/cloud/index.mdx deleted file mode 100644 index 99c526f7..00000000 --- a/docs/content/docs/cloud/index.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Cloud Service -description: Cloud Service ---- \ No newline at end of file diff --git a/docs/content/docs/cloud/meta.json b/docs/content/docs/cloud/meta.json deleted file mode 100644 index c686516d..00000000 --- a/docs/content/docs/cloud/meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "title": "Cloud Service", - "description": "Cloud Service", - "root": true -} \ No newline at end of file diff --git a/docs/content/docs/home/Telemetry.mdx b/docs/content/docs/home/Telemetry.mdx index ad1586c0..b6c1d1e3 100644 --- a/docs/content/docs/home/Telemetry.mdx +++ b/docs/content/docs/home/Telemetry.mdx @@ -1,16 +1,17 @@ --- -title: Telemetry in CUA -description: This document explains how telemetry works in CUA libraries and how you can control it. +title: Telemetry in C/ua +description: This document explains how telemetry works in C/ua libraries and how you can control it. --- -# Telemetry in CUA -This document explains how telemetry works in CUA libraries and how you can control it. +# Telemetry in C/ua -CUA tracks anonymized usage and error report statistics; we ascribe to Posthog's approach as detailed [here](https://posthog.com/blog/open-source-telemetry-ethical). If you would like to opt out of sending anonymized info, you can set `telemetry_enabled` to false. +This document explains how telemetry works in C/ua libraries and how you can control it. + +C/ua tracks anonymized usage and error report statistics; we ascribe to Posthog's approach as detailed [here](https://posthog.com/blog/open-source-telemetry-ethical). If you would like to opt out of sending anonymized info, you can set `telemetry_enabled` to false. ## What telemetry data we collect -CUA libraries collect minimal anonymous usage data to help improve our software. The telemetry data we collect is specifically limited to: +C/ua libraries collect minimal anonymous usage data to help improve our software. The telemetry data we collect is specifically limited to: - Basic system information: - Operating system (e.g., 'darwin', 'win32', 'linux') @@ -20,6 +21,7 @@ CUA libraries collect minimal anonymous usage data to help improve our software. - Version of the module being used We do NOT collect: + - Personal information - Contents of files - Specific text being typed @@ -47,7 +49,9 @@ export CUA_TELEMETRY_ENABLED=false CUA_TELEMETRY_ENABLED=1 python your_script.py ``` + Or from Python: + ```python import os os.environ["CUA_TELEMETRY_ENABLED"] = "false" @@ -55,7 +59,7 @@ os.environ["CUA_TELEMETRY_ENABLED"] = "false" ## 2. Instance-Level Control -You can control telemetry for specific CUA instances by setting `telemetry_enabled` when creating them: +You can control telemetry for specific C/ua instances by setting `telemetry_enabled` when creating them: ```python # Disable telemetry for a specific Computer instance @@ -75,4 +79,4 @@ Note that telemetry settings must be configured during initialization and cannot ## Transparency -We believe in being transparent about the data we collect. If you have any questions about our telemetry practices, please open an issue on our GitHub repository. \ No newline at end of file +We believe in being transparent about the data we collect. If you have any questions about our telemetry practices, please open an issue on our GitHub repository. diff --git a/docs/content/docs/home/index.mdx b/docs/content/docs/home/index.mdx index 96f030a5..5a100a6c 100644 --- a/docs/content/docs/home/index.mdx +++ b/docs/content/docs/home/index.mdx @@ -1,13 +1,13 @@ --- -title: CUA Documentation -description: CUA Documentation +title: C/ua Documentation +description: C/ua Documentation --- -## What is CUA? +## What is C/ua? -Cua is a collection of libraries and tools for building Computer-Use AI agents. +C/ua is a collection of libraries and tools for building Computer-Use AI agents. - + diff --git a/docs/content/docs/libraries/agent.mdx b/docs/content/docs/home/libraries/agent.mdx similarity index 98% rename from docs/content/docs/libraries/agent.mdx rename to docs/content/docs/home/libraries/agent.mdx index 69dbdeab..c3e7c0f3 100644 --- a/docs/content/docs/libraries/agent.mdx +++ b/docs/content/docs/home/libraries/agent.mdx @@ -38,7 +38,7 @@ title: Agent -**cua-agent** is a general Computer-Use framework for running multi-app agentic workflows targeting macOS and Linux sandbox created with Cua, supporting local (Ollama) and cloud model providers (OpenAI, Anthropic, Groq, DeepSeek, Qwen). +**cua-agent** is a general Computer-Use framework for running multi-app agentic workflows targeting macOS and Linux sandbox created with C/ua, supporting local (Ollama) and cloud model providers (OpenAI, Anthropic, Groq, DeepSeek, Qwen). ### Get started with Agent diff --git a/docs/content/docs/libraries/computer-server.mdx b/docs/content/docs/home/libraries/computer-server.mdx similarity index 100% rename from docs/content/docs/libraries/computer-server.mdx rename to docs/content/docs/home/libraries/computer-server.mdx diff --git a/docs/content/docs/libraries/computer.mdx b/docs/content/docs/home/libraries/computer.mdx similarity index 100% rename from docs/content/docs/libraries/computer.mdx rename to docs/content/docs/home/libraries/computer.mdx diff --git a/docs/content/docs/libraries/core.mdx b/docs/content/docs/home/libraries/core.mdx similarity index 100% rename from docs/content/docs/libraries/core.mdx rename to docs/content/docs/home/libraries/core.mdx diff --git a/docs/content/docs/home/libraries/index.mdx b/docs/content/docs/home/libraries/index.mdx new file mode 100644 index 00000000..83701a90 --- /dev/null +++ b/docs/content/docs/home/libraries/index.mdx @@ -0,0 +1,8 @@ +--- +title: Getting Started +description: Getting started with the C/ua libraries +--- + +## Overview + +The C/ua project provides several libraries for building Computer-Use AI agents. diff --git a/docs/content/docs/libraries/lume/API-Reference.mdx b/docs/content/docs/home/libraries/lume/API-Reference.mdx similarity index 100% rename from docs/content/docs/libraries/lume/API-Reference.mdx rename to docs/content/docs/home/libraries/lume/API-Reference.mdx diff --git a/docs/content/docs/libraries/lume/Development.mdx b/docs/content/docs/home/libraries/lume/Development.mdx similarity index 100% rename from docs/content/docs/libraries/lume/Development.mdx rename to docs/content/docs/home/libraries/lume/Development.mdx diff --git a/docs/content/docs/libraries/lume/FAQ.mdx b/docs/content/docs/home/libraries/lume/FAQ.mdx similarity index 100% rename from docs/content/docs/libraries/lume/FAQ.mdx rename to docs/content/docs/home/libraries/lume/FAQ.mdx diff --git a/docs/content/docs/libraries/lume/index.mdx b/docs/content/docs/home/libraries/lume/index.mdx similarity index 98% rename from docs/content/docs/libraries/lume/index.mdx rename to docs/content/docs/home/libraries/lume/index.mdx index 1102b6e4..8d8870d4 100644 --- a/docs/content/docs/libraries/lume/index.mdx +++ b/docs/content/docs/home/libraries/lume/index.mdx @@ -46,7 +46,7 @@ lume run macos-sequoia-vanilla:latest ## Development Environment -If you're working on Lume in the context of the CUA monorepo, we recommend using the dedicated VS Code workspace configuration: +If you're working on Lume in the context of the C/ua monorepo, we recommend using the dedicated VS Code workspace configuration: ```bash # Open VS Code workspace from the root of the monorepo diff --git a/docs/content/docs/libraries/lumier.mdx b/docs/content/docs/home/libraries/lumier.mdx similarity index 100% rename from docs/content/docs/libraries/lumier.mdx rename to docs/content/docs/home/libraries/lumier.mdx diff --git a/docs/content/docs/libraries/mcp-server.mdx b/docs/content/docs/home/libraries/mcp-server.mdx similarity index 100% rename from docs/content/docs/libraries/mcp-server.mdx rename to docs/content/docs/home/libraries/mcp-server.mdx diff --git a/docs/content/docs/libraries/meta.json b/docs/content/docs/home/libraries/meta.json similarity index 82% rename from docs/content/docs/libraries/meta.json rename to docs/content/docs/home/libraries/meta.json index 7418d368..3e4309f0 100644 --- a/docs/content/docs/libraries/meta.json +++ b/docs/content/docs/home/libraries/meta.json @@ -2,10 +2,7 @@ "title": "Libraries", "description": "Libraries", "icon": "Library", - "root": true, "pages": [ - "index", - "---Libraries---", "agent", "computer", "computer-server", diff --git a/docs/content/docs/libraries/pylume.mdx b/docs/content/docs/home/libraries/pylume.mdx similarity index 100% rename from docs/content/docs/libraries/pylume.mdx rename to docs/content/docs/home/libraries/pylume.mdx diff --git a/docs/content/docs/libraries/som.mdx b/docs/content/docs/home/libraries/som.mdx similarity index 100% rename from docs/content/docs/libraries/som.mdx rename to docs/content/docs/home/libraries/som.mdx diff --git a/docs/content/docs/home/meta.json b/docs/content/docs/home/meta.json index 035c9092..96b89154 100644 --- a/docs/content/docs/home/meta.json +++ b/docs/content/docs/home/meta.json @@ -1,6 +1,12 @@ { "title": "Home", - "description": "Documentation Home", + "description": "Documentation Home", "root": true, - "defaultOpen": true -} + "defaultOpen": true, + "pages": [ + "libraries", + "faq", + "developer-guide", + "telemetry" + ] +} \ No newline at end of file diff --git a/docs/content/docs/libraries/index.mdx b/docs/content/docs/libraries/index.mdx deleted file mode 100644 index d3dc51db..00000000 --- a/docs/content/docs/libraries/index.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Getting Started -description: Getting started with the c/ua libraries ---- - -## Overview - -The CUA project provides several libraries for building Computer-Use AI agents. diff --git a/docs/src/app/(home)/layout.tsx b/docs/src/app/(home)/layout.tsx index ccab1a5c..05828e12 100644 --- a/docs/src/app/(home)/layout.tsx +++ b/docs/src/app/(home)/layout.tsx @@ -1,38 +1,32 @@ -import { DocsLayout } from 'fumadocs-ui/layouts/docs'; -import type { ReactNode } from 'react'; -import { baseOptions } from '@/app/layout.config'; -import { source } from '@/lib/source'; -import { Home, Library, Cloud } from 'lucide-react'; +import { DocsLayout } from "fumadocs-ui/layouts/docs"; +import type { ReactNode } from "react"; +import { baseOptions } from "@/app/layout.config"; +import { source } from "@/lib/source"; +import { Home, Library, Cloud, Globe } from "lucide-react"; export default function Layout({ children }: { children: ReactNode }) { - return ( - , - }, - { - url: '/libraries', - title: 'Libraries', - description: 'Library Documentation', - icon: , - }, - { - url: '/cloud', - title: 'Cloud', - description: 'Cua Cloud Documentation', - icon: , - }, - ], - }} - {...baseOptions} - > - {children} - - ); + return ( + , + }, + { + url: "/api", + title: "API Reference", + description: "API Reference for C/ua libraries and services", + icon: , + }, + ], + }} + {...baseOptions} + > + {children} + + ); } diff --git a/docs/src/app/layout.config.tsx b/docs/src/app/layout.config.tsx index 1e63faa6..b33b2486 100644 --- a/docs/src/app/layout.config.tsx +++ b/docs/src/app/layout.config.tsx @@ -38,11 +38,6 @@ export const baseOptions: BaseLayoutProps = { }, githubUrl: 'https://github.com/trycua/cua', links: [ - { - url: '/home', - text: 'Documentation Home', - icon: , - }, { url: 'https://trycua.com', text: 'cua home',