Skip to content

HeadyAI/heady-docs

Repository files navigation

Heady™ Documentation Hub

Single Source of Truth for all Heady project documentation

Patents Repos MCP Tools


Quick Start

  1. New to Heady? Start with the Executive Overview
  2. Understand the stack — Read the Architecture & Patterns
  3. Browse services — See the Service Catalog (30+ MCP tools)
  4. Clone the monorepoHeady-pre-production

Vault Structure

heady-docs/
├── 00_Overview/        — Platform vision, comprehensive source (v3.1)
├── 01_Architecture/    — Production system map, domains, auth, Colab cluster
├── 02_Services/        — 30+ MCP tools catalog and design patterns
├── 03_Patents/         — 51+ USPTO provisional applications (full-text Batch 4)
├── 04_API_Reference/   — Service inventory and environment variable reference
├── 05_Strategic/       — Valuation, market research, investor targets
├── 06_Trading/         — APEX autonomous trading intelligence
├── 07_IP_Portfolio/    — IP portfolio analysis and strategic valuation
├── Assets/             — Shared media and design assets
├── site/               — Pre-built static HTML/CSS documentation hub
└── sources/            — Legacy sources (HEADY_KNOWLEDGE_VAULT.md preserved)

Documentation Index

Section Description
00 Overview Platform vision, philosophy, and comprehensive source (v3.1)
Executive Overview Platform vision and market position
Comprehensive Source Full platform deep-dive (v3.1)
01 Architecture Production infrastructure deep-dives
Production Architecture End-to-end system map and operator navigation guide
Site & Domain Registry Canonical registry of all 12 domains, routing, and CORS
Auth Contract Cross-site auth model — API keys, OAuth PKCE, HMAC webhooks
Colab Control Plane 3-runtime GPU cluster, latent-space ops, task dispatch
02 Services MCP tool catalog and service design patterns
Service Catalog 30+ MCP tools across 7 domains
Architecture & Patterns Six-layer stack and design patterns
03 Patents 51+ USPTO provisional applications
Patent Index Full portfolio index with filing details
04 API Reference Service inventory and environment setup
API Keys Reference 14 external services with env var names
05 Strategic Valuation models and investor intelligence
Value Assessment Q1 2026 Q1 2026 valuation and growth projections
Knowledge Vault Notion-synced project data package
06 Trading Autonomous trading intelligence
APEX Trading Intelligence APEX autonomous trading architecture
07 IP Portfolio IP portfolio analysis and valuation
IP Portfolio & Valuation 51+ patents, valuation, and strategy

Architecture at a Glance

Layer 1  Edge        — Cloudflare CDN, DDoS, Edge Workers, SSL (12 domains)
Layer 2  Gateway     — Auth (HEADY_API_KEY), Rate Limiting, mTLS
Layer 3  Orchestrate — Swarm Conductor, Bee Factory, Task Routing
Layer 4  Intelligence — Multi-Model (GPT-4o, Claude, Gemini, Groq), Ternary Logic
Layer 5  Memory      — 3D Vectors (Pinecone), pgvector (Neon), Embeddings
Layer 6  Persistence — Neon Postgres, Audit Logs, Config Store

Authentication Model

  • API Gateway: All requests authenticate via HEADY_API_KEY at Layer 2
  • Admin: Elevated operations require ADMIN_TOKEN
  • Edge Security: Cloudflare handles SSL, DDoS, and rate limiting at Layer 1
  • Service-to-Service: Scoped tokens with least-privilege access
  • Secrets: Environment variables only — never hardcoded. 1Password SA for managed rotation.

See API & Services Reference for the full service inventory.


Deployment Stack

Component Service Role
CDN / Edge Cloudflare Workers 12 domains, dynamic delivery, DNS
API / Backend Google Cloud Run heady-manager, serverless MCP bridge
Database Neon Postgres (Scale) PG 16, pgvector, 5 tables
Vector Store Pinecone Distributed vector DB for embeddings
GPU Compute 3-Node Colab Pro+ Overmind, Forge, Edge nodes
Error Tracking Sentry Project: heady-manager
Secrets 1Password SA Service account token management
Payments Stripe (Live) Subscription billing

Connected Sources

NotebookLM

All documents in 00_Overview/ are optimized for NotebookLM ingestion:

  • Upload to create cinematic explainer videos
  • Deep-dive audio overviews
  • Interactive Q&A sessions

GitHub Repository Ecosystem

Repository Purpose Visibility
Heady-pre-production Official monorepo — single source of truth Public
heady-docs Documentation hub (this repo) Public
latent-core-dev Synaptic Dev — pgvector ↔ Antigravity Private
template-mcp-server Template — MCP protocol server Private
template-swarm-bee Template — Swarm Agent lifecycle Private
template-heady-ui Template — React Module Federation Private
HeadyBuddy Chrome Extension Private
HeadyWeb Web portal Private
HeadyAI-IDE IDE Extension Private
admin-ui Admin dashboard Private

Battle Arena (9 repos): Competitive rebuilds — Groq, Claude, Gemini, GPT-5.4, Codex, Perplexity, HeadyCoder, HuggingFace, Jules


Deploy as Static Site

# GitHub Pages: Settings → Pages → Source: main → /site
# Or use Cloudflare Pages / Vercel pointing to /site

The /site directory contains a pre-built static HTML/CSS documentation hub. No build step required.


© 2026 Heady Systems LLC. All rights reserved.

About

Heady™ Documentation Hub — Single Source of Truth for all project docs, patents, architecture, and API references

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors