Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 175 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Heady Repository - GitHub Copilot Instructions

## Project Overview

This is the **Heady Directive Monorepo** - a sovereignty-focused system architecture featuring AI-powered components, secure identity management, and compliance-enforced governance.

Generated by Codex v13 (Heady Golden Master Builder v13.0.0).

### Identity & Ownership
- **Assignee:** HeadySystems Inc.
- **Inventor:** Eric Haywood
- **Trust Domain:** headysystems.com
- **App Domain:** app.headysystems.com

## Repository Structure

```
/HeadySystems_v13/ # Main monorepo directory
├── apps/ # Application verticals
│ ├── heady_admin_ui/ # Unified personal admin dashboard
│ ├── heady_field/ # Field management application
│ ├── heady_kinetic/ # Kinetic application
│ ├── heady_legacy/ # Legacy system support
│ └── heady_make/ # Make application
├── ai/ # AI/ML components
│ ├── tempo-engine/ # Predictive prefetching & cache warm-up
│ ├── mcp-gateway/ # MCP (Model Context Protocol) gateway
│ ├── docs-guardian/ # Documentation guardian
│ └── intel-edge/ # Intelligence edge processing
├── docs/ # Documentation
│ ├── crypto/ # Cryptographic specifications
│ ├── ops/ # Operational documentation
│ ├── patents/ # Patent disclosures and inventions
│ └── security/ # Security architecture docs
├── scripts/ # Automation scripts
├── CONTEXT.md # Sovereign node context
├── AGENTS.md # Agent guidance for monorepo
└── REGISTRY.json # System registry configuration
```

## Technology Stack

- **Primary Language:** Python 3
- **Build System:** Makefile, custom codex builder scripts
- **Architecture:** Monorepo with strict vertical isolation
- **Security:** Governance-locked, audit-enabled, tunnel-only gateway (127.0.0.1)
- **Compliance:** PPA-001, PPA-002, PPA-003, PPA-004

## Core Principles & Rules

### 1. Security & Compliance

- **CRITICAL:** This repository contains patent-pending intellectual property. Never expose sensitive patent details, cryptographic implementations, or proprietary algorithms in public contexts.
- **Gateway Security:** All traffic routes through 127.0.0.1 (tunnel-only). Never expose services on public interfaces.
- **Governance Lock:** The system is governance-locked (v1.2.0). Do not bypass or disable governance controls.
- **PromptOps:** PromptOps enforcement is mandatory. Follow established prompt patterns.
- **Audit Trail:** All operations must maintain audit logs. Never disable audit_enabled in configurations.

### 2. Data Isolation

- **Strict vertical isolation** between application modules is mandatory
- **No cross-vertical database sharing** or data replication
- Each vertical (app) is its own compliance boundary
- Shared services may only exchange non-sensitive metadata for routing

### 3. Code Generation & Modification

- **DO NOT EDIT files marked as "DO NOT EDIT"** - these are deterministically generated from REGISTRY.json
- Files generated by Codex Builder are immutable unless regenerated through the builder
- Always check file headers for generation notices before editing
- When modifying generated content, use the appropriate builder script

### 4. Deterministic & Verifiable

- The repository is designed for deterministic generation and verification
- SHA-256 checksums are used for artifact verification (see DELIVERY_MANIFEST.md)
- Maintain cryptographic integrity of generated artifacts
- Use AtomicWriter patterns for file operations to prevent corruption

### 5. Naming Conventions

- **Python:** Use snake_case for functions, variables, and file names
- **Directories:** Use lowercase with underscores (e.g., `heady_admin_ui`)
- **Constants:** Use UPPER_SNAKE_CASE
- **Trust domains:** Always use the format `*.headysystems.com`

### 6. Destructive Operations

- The codebase includes safeguards against destructive patterns: ["write", "delete", "rm", "exec", "shell", "edit_file"]
- When implementing features, avoid direct file system manipulation where possible
- Use the AtomicWriter class for safe file operations
- Never bypass safety mechanisms

## Development Workflow

### Building & Testing

```bash
# Bootstrap development environment (minimal - currently just echoes status)
make dev-bootstrap

# Apply codex (when regenerating the repository structure)
./HeadySystems_v13/apply_codex_v13.sh
```

**Note:** The build system is minimal by design. Most components are deterministically generated by the Codex Builder.

### File Verification

Always verify artifact integrity:
```bash
# Check against DELIVERY_MANIFEST.md
sha256sum HeadySystems_Install_Pkg.zip
sha256sum heady_demo_kit.zip
```

## AI/ML Components

### Tempo Engine
Handles predictive prefetching and cache warm-up. Coordinate with this component for performance optimization.

### MCP Gateway
Model Context Protocol gateway - the central hub for AI model communication. Related to Patent 11.

### Docs Guardian
Monitors and maintains documentation integrity. Consult before major documentation changes.

## Patent Portfolio Context

This repository implements and protects a foundational patent portfolio (Assets 1-42) including:

- **PTACA:** Physical Trust-Anchored Cryptographic Authorization
- **RAAS:** Remote-Attested Actuator Systems
- **Sovereign Identity Root:** Decentralized identity architecture
- **HSM Federation:** Distributed trust fabric
- **Secure Mesh Transport:** Hardware-identity-based routing
- **Data Sovereignty Vaults:** Jurisdiction-enforced storage

When working on security, cryptographic, or identity-related features, be aware these may touch patented inventions. Maintain confidentiality and architectural integrity.

## Testing & Quality

- Test changes in isolated vertical contexts
- Respect compliance boundaries in test scenarios
- Never commit test data that violates data isolation principles
- Maintain audit trails even in test environments

## Documentation

- Keep CONTEXT.md in sync with architectural changes
- Update AGENTS.md if agent behavior guidelines change
- Patent disclosures go in `docs/patents/`
- Security architecture documents go in `docs/security/`

## What NOT to Do

❌ **NEVER:**
- Edit files marked "DO NOT EDIT" without using the codex builder
- Share or expose patent-pending implementation details publicly
- Disable governance locks or audit logging
- Allow cross-vertical data sharing
- Expose services on non-localhost interfaces
- Bypass PromptOps enforcement
- Commit secrets, credentials, or sensitive keys
- Remove or modify safety mechanisms for destructive operations

## Additional Resources

- See `DELIVERY_MANIFEST.md` for artifact verification
- See `CONTEXT.md` for sovereign node identity details (brief overview)
- See `AGENTS.md` for monorepo data isolation guidance
- See `docs/patents/INVENTION_DISCLOSURE_INDEX.md` for patent IP index (summary)
- See `docs/ops/IP_INTEGRATION.md` for patent integration mapping (summary)

**Note:** Many documentation files are intentionally brief - this is a deterministically generated repository with minimal, focused documentation.
28 changes: 28 additions & 0 deletions HeadySystems_v13/apps/heady_admin_ui/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# Heady Admin UI
Unified personal admin dashboard and control panel.

## Sinusoidal Wave Visualizations

This application includes dynamic sinusoidal wave visualizations for enhanced user interaction feedback.

### Features

- **Communication Feedback Waves**: Real-time visual representation of AI-user interaction intensity
- **Heady Lens Hover Dynamics**: Dynamic oscillations during component scanning
- **Customization Options**: User-accessible controls for amplitude, frequency, speed, and color
- **Accessibility Support**: Reduced motion, high contrast, and color-blind safe modes
- **Privacy-First**: All settings stored locally, never transmitted

### Quick Start

1. Open `wave_demo.html` in a browser to see the interactive demo
2. Include `sinusoidal_wave.js` and `wave_customization.js` in your application
3. See `docs/ops/SINUSOIDAL_WAVE_INTEGRATION.md` for complete documentation

### Files

- `sinusoidal_wave.js` - Core wave rendering engine with golden ratio harmonics
- `wave_customization.js` - User settings and accessibility features
- `wave_demo.html` - Interactive demonstration and usage examples

### Documentation

See `/HeadySystems_v13/docs/ops/SINUSOIDAL_WAVE_INTEGRATION.md` for comprehensive integration guide.
Loading