From bbae102ba5ba8b00604eec91bb61295f3d5f623e Mon Sep 17 00:00:00 2001
From: Claude <noreply@anthropic.com>
Date: Thu, 12 Feb 2026 09:33:43 +0000
Subject: [PATCH] Add project README

https://claude.ai/code/session_016wHZkMFCL6SDDKJx8EBWCT
---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c11dd36
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# OpenTrace Documentation
+
+Documentation site for [OpenTrace](https://opentrace.ai) — gives your AI assistant deep understanding of your system architecture so you can ask questions about services, dependencies, and how everything connects.
+
+**Live site:** [docs.opentrace.com](https://docs.opentrace.com)
+
+## Development
+
+### Prerequisites
+
+- Python 3.x
+
+### Local Development
+
+```bash
+# Install dependencies
+pip install -r requirements.txt
+
+# Start local dev server (runs on http://127.0.0.1:3009)
+mkdocs serve
+
+# Build static site
+mkdocs build
+```
+
+### Project Structure
+
+```
+docs/
+├── assets/                  # Images, logos, favicons
+├── integrations/            # Integration guides (Claude Code, GitHub, GitLab, etc.)
+├── snippets/                # Reusable documentation snippets
+├── index.md                 # Home page
+├── getting-started.md       # Setup and quick start
+├── capabilities.md          # Full reference of supported queries
+├── workflows.md             # Example use cases
+├── otignore.md              # .otignore file documentation
+├── privacy-policy.md        # Privacy policy
+└── terms-of-service.md      # Terms of service
+mkdocs.yml                   # MkDocs configuration
+requirements.txt             # Python dependencies
+```
+
+## Deployment
+
+Deployment is handled automatically via GitHub Actions.
+
+- **Main branch** (`main`): Deploys to production at `https://docs.opentrace.com/`
+- **All other branches**: Deploy to preview URLs at `https://docs.opentrace.com/preview/<branch-name>/`
+
+Preview deployments are automatically cleaned up when their branch is deleted.
+
+### Workflows
+
+| Workflow | Trigger | Purpose |
+|----------|---------|---------|
+| `deploy.yml` | Push to any branch, PRs to main | Build and deploy the site |
+| `cleanup-preview.yml` | Branch deletion | Remove preview deployments |