Skip to content

Documentation Guide

This guide helps you navigate Lucid's documentation based on your role and goals. Whether you're a developer, compliance officer, or just exploring, find the right path below.

Quick Reference

I want to... Start here
Deploy something in 5 minutes Quickstart Guides
Understand what Lucid does Home
Build a custom auditor First Auditor Tutorial
Set up compliance controls Compliance Overview
Debug an issue Troubleshooting

Learning Paths

Path 1: New to Lucid (Start Here)

Goal: Understand what Lucid does and deploy your first environment.

flowchart LR
    A["1. Home<br/>(What is Lucid?)"] --> B["2. Quickstart<br/>(Deploy in 5 min)"]
    B --> C["3. Architecture<br/>(How it works)"]
    C --> D["4. TEE Concepts<br/>(Security model)"]
Step Document Time
1 Home - What is Lucid? 5 min
2 5-Minute Chat Quickstart 5 min
3 Architecture Overview 15 min
4 Confidential Computing & TEEs 10 min

After completing this path, you'll understand Lucid's value proposition and have a working deployment.

Path 2: Auditor Developer

Goal: Build and deploy custom auditors for your specific use case.

flowchart LR
    A["1. First Auditor<br/>(Tutorial)"] --> B["2. Auditor Development<br/>(SDK Patterns)"]
    B --> C["3. Policy as Code<br/>(LPL Rules)"]
    C --> D["4. Deployment<br/>(Publishing)"]
Step Document Time
1 First Auditor Tutorial 30 min
2 Auditor Development Guide 45 min
3 Policy as Code 30 min
4 Deployment Guide 20 min

Reference materials: - Auditor Interface Spec — HTTP API contract - SDK Reference — Python SDK docs - Auditor Catalog — Official auditor examples

Path 3: DevOps / Platform Engineer

Goal: Deploy and manage Lucid infrastructure in production.

flowchart LR
    A["1. Deployment Modes<br/>(Choose approach)"] --> B["2. Cluster Setup<br/>(K8s config)"]
    B --> C["3. Operator Webhook<br/>(Injection flow)"]
    C --> D["4. Production Checklist<br/>(Go-live)"]
Step Document Time
1 Deployment Modes 15 min
2 Cluster Setup 30 min
3 Operator Webhook Flow 20 min
4 Production Checklist 15 min

Reference materials: - CLI Reference — Command documentation - Configuration Reference — Environment variables - Troubleshooting — Common issues

Path 4: Compliance Officer / GRC

Goal: Understand how Lucid supports regulatory compliance.

flowchart LR
    A["1. Compliance Overview<br/>(Framework coverage)"] --> B["2. Specific Framework<br/>(GDPR/HIPAA/etc)"]
    B --> C["3. Auditor Catalog<br/>(Control mappings)"]
    C --> D["4. Policy as Code<br/>(Custom rules)"]
Step Document Time
1 Compliance Overview 15 min
2 Choose your framework: GDPR, HIPAA, SOC 2, EU AI Act 20 min
3 Auditor Catalog 15 min
4 Policy as Code (optional) 30 min

Key concepts: - AI Passport — Cryptographic compliance certificates - TEE Attestation — Hardware-backed proof

Path 5: Security Engineer

Goal: Understand Lucid's security model and trust boundaries.

flowchart LR
    A["1. TEE Concepts<br/>(Trust model)"] --> B["2. Architecture<br/>(RATS flow)"]
    B --> C["3. Operator Webhook<br/>(Injection)"]
    C --> D["4. ZK Proofs<br/>(Privacy)"]
Step Document Time
1 Confidential Computing & TEEs 15 min
2 Architecture Overview 20 min
3 Operator Webhook Flow 20 min
4 Zero-Knowledge Proofs 15 min

External references: - RFC 9334 (RATS) — Remote Attestation standard - Auditor Interface Spec — Technical contract

Document Types

Lucid documentation is organized into these categories:

Type Purpose Examples
Quickstart Get running fast 5-minute guides, serverless deploy
Tutorial Learn by doing First auditor, step-by-step walkthroughs
Concept Understand the "why" Architecture, TEE, glossary
Guide Complete a task Deployment, policy configuration
Reference Look up details SDK API, CLI commands, config options
Compliance Regulatory guidance GDPR, HIPAA, SOC 2 mappings

Glossary

New to the terminology? The Glossary defines key terms including:

  • TEE — Trusted Execution Environment
  • AI Passport — Cryptographic compliance certificate
  • Auditor — Security check component in the chain
  • RATS — Remote ATtestation procedureS (RFC 9334)
  • Evidence — Claims produced by auditors
  • Appraisal — Verification of evidence against policy

Getting Help

Feedback

Found an issue with the documentation? Have a suggestion?