README.md

Veil Docs

This directory is the canonical documentation entry for Veil.

Veil is being built as an agent-operated AI capacity marketplace. Today the canonical runtime surface is an AI inference routing system with four primary runtime roles:

• Consumer: local OpenAI-compatible gateway
• Relay: verification, routing, limits, and witness
• Provider: upstream execution
• Bootstrap: Relay discovery

The target market surface adds Claw automation, sell-side policy, and settlement flows on top of this runtime baseline.

Choose A Path

• New to the project: Overview -> Product Design -> Design Governance -> Technical Design
• Installing or operating Veil: Installation -> Manual -> Operations
• Configuring nodes: Configuration
• Integrating clients or tools: Clients
• Understanding trust and privacy boundaries: Trust and Privacy
• Implementing or reviewing protocol behavior: Protocol
• Working on contribution accounting or governance: Governance and Economics -> Roadmap Use execution-rules.md when sequencing implementation work.

System At A Glance

Client -> Consumer Gateway -> Relay -> Provider -> Upstream AI
                     \-> Budget      \-> Witness
Bootstrap -> Relay discovery
RBOB -> contribution accounting

Documentation Sections

• product-design/: product scope, trust and privacy stance, governance economics, and roadmap
• technical-design/: system model, architecture, modules, protocol, and runtime configuration
• design-governance/: product vision and traceability governance See also documentation-governance-rules.md for classification and maintenance standards.
• clients/: local gateway integration guides
• operations/: deployment, persistence, limits, observability
• manual/: role-based runtime usage
• installation/: setup and first-time environment preparation
• glossary/: stable public terminology

Module Index

The module docs are organized by implementation boundary:

• wallet-identity
• consumer-gateway
• network-transport
• relay
• provider-engine
• metering-witness
• bootstrap-discovery
• claw-autopilot
• pricing-risk-policy
• settlement-payout
• cli
• rbob-ledger

Naming Convention

• top-level design categories use kebab-case nouns: product-design, technical-design, design-governance
• each directory entry file is README.md (or README.zh.md)
• paired bilingual documents use .md and .zh.md with identical base names

Language

• English entry: README.md
• Chinese entry: README.zh.md

Every documentation directory follows the same convention.