Reorganize docs layout, use c/ua instead of CUA

This commit is contained in:
Morgan Dean
2025-06-20 13:03:03 -07:00
parent 4cada0cd04
commit 61deb4e9a7
24 changed files with 74 additions and 78 deletions

View File

@@ -0,0 +1,4 @@
---
title: API Reference Home
description: API Reference
---

View File

@@ -0,0 +1,5 @@
{
"title": "API Reference",
"description": "API Reference",
"root": true
}

View File

@@ -1,4 +0,0 @@
---
title: Cloud Service
description: Cloud Service
---

View File

@@ -1,5 +0,0 @@
{
"title": "Cloud Service",
"description": "Cloud Service",
"root": true
}

View File

@@ -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.
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.

View File

@@ -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.
<Cards>
<Card title="Libraries" href="/libraries" />
<Card title="Cloud Service" href="/cloud"/>
<Card title="Cloud Service" href="/cloud" />
</Cards>

View File

@@ -38,7 +38,7 @@ title: Agent
</a>
</div>
**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

View File

@@ -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.

View File

@@ -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

View File

@@ -2,10 +2,7 @@
"title": "Libraries",
"description": "Libraries",
"icon": "Library",
"root": true,
"pages": [
"index",
"---Libraries---",
"agent",
"computer",
"computer-server",

View File

@@ -1,6 +1,12 @@
{
"title": "Home",
"description": "Documentation Home",
"description": "Documentation Home",
"root": true,
"defaultOpen": true
}
"defaultOpen": true,
"pages": [
"libraries",
"faq",
"developer-guide",
"telemetry"
]
}

View File

@@ -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.

View File

@@ -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 (
<DocsLayout
tree={source.pageTree}
sidebar={{
tabs: [
{
url: '/home',
title: 'Home',
description: 'Welcome to Cua Documentation',
icon: <Home />,
},
{
url: '/libraries',
title: 'Libraries',
description: 'Library Documentation',
icon: <Library />,
},
{
url: '/cloud',
title: 'Cloud',
description: 'Cua Cloud Documentation',
icon: <Cloud />,
},
],
}}
{...baseOptions}
>
{children}
</DocsLayout>
);
return (
<DocsLayout
tree={source.pageTree}
sidebar={{
tabs: [
{
url: "/home",
title: "Home",
description: "Welcome to the C/ua Documentation",
icon: <Home />,
},
{
url: "/api",
title: "API Reference",
description: "API Reference for C/ua libraries and services",
icon: <Globe />,
},
],
}}
{...baseOptions}
>
{children}
</DocsLayout>
);
}

View File

@@ -38,11 +38,6 @@ export const baseOptions: BaseLayoutProps = {
},
githubUrl: 'https://github.com/trycua/cua',
links: [
{
url: '/home',
text: 'Documentation Home',
icon: <HomeIcon />,
},
{
url: 'https://trycua.com',
text: 'cua home',