TECHNICAL DOCUMENTATION

MY OWL Documentation

Comprehensive reference guides, architecture deep-dives, verification contracts, and API integration specifications.

Core Model: Ingest → AST Trace → Deterministic Plan → 4 Gates → Draft PR
View 9-Stage Pipeline Specification
Getting Started

Step-by-step setup guides to connect your GitHub organization, configure repositories, and run an initial AST scan.

Connecting the GitHub App

How to install the official MY OWL GitHub App and authorize specific organizations or repositories.

docs/getting-started

Selecting Protected Repositories

Configuring which repositories are continuously monitored for upstream breaking changes.

docs/getting-started

Triggering Your First AST Scan

Initiating a baseline scan from the dashboard and understanding the scan worker lifecycle.

docs/getting-started
Core Concepts

The fundamental architectural concepts behind MY OWL's detection, tracing, and verification engines.

Findings: Open vs. Resolved

How findings are detected, tracked, and updated across multiple repository re-scans.

docs/core-concepts

Detected vs. Affected Usage

Why package manifest presence does not mean broken code, and how AST symbol tracing eliminates 90% false positive noise.

docs/core-concepts

Deterministic Migration Plans

How context-bounded AST transformation rules synthesize minimal, syntax-safe code replacements.

docs/core-concepts

The 4-Gate Verification Harness

Deep dive into AST syntax validity, TypeScript compiler diagnostics, call-site scope checks, and test runner dry-runs.

docs/core-concepts

GitHub Draft Pull Requests

Why MY OWL stops at a Draft PR on an isolated branch rather than auto-merging into main.

docs/core-concepts
GitHub Integration & Permissions

Permissions, authentication mechanics, branch policies, and baseline integrity protection.

GitHub App Scopes & Least Privilege

Detailed explanation of why we request contents:read and pull_requests:write, with zero main branch write access.

docs/github-integration

Isolated Branch Policy (apiproof/*)

How branch naming conventions prevent accidental collisions with developer branches.

docs/github-integration

Repository Divergence Protection

How MY OWL verifies that default branch HEAD hasn't moved since the scan, failing closed if divergence occurs.

docs/github-integration
Security & Verification Boundaries

Authentication, tenant isolation, webhook HMAC validation, and signed execution evidence.

Workspace Multi-Tenancy

How user permissions, repositories, and scan findings are partitioned securely across workspaces.

docs/security

Webhook Signature Validation

Verifying GitHub webhook delivery authenticity with HMAC-SHA256 signatures.

docs/security

Execution-Bound Verification Evidence

Cryptographic binding of repository ID, baseline commit SHA, change ID, and patch digest.

docs/security
Supported APIs & Rule Catalogs

Currently verified vendor catalogs and our active integration expansion roadmap.

Stripe Node SDK Catalog

Monitored subscription coupon parameters, customer creation payloads, and v17 to v18 migration rules.

docs/supported-apis

Twilio Node SDK Catalog

Monitored messaging service changes, toll-free verification schemas, and call recording API updates.

docs/supported-apis

Planned Provider Roadmap

Upcoming support for OpenAI, GitHub Octokit, Supabase, Resend, and custom OpenAPI schema ingestion.

docs/supported-apis

Have technical questions or custom API requirements?

Explore our engineering articles on AST analysis and verification, or reach out to our team for custom rule integration.