Developer Surface Map

This page is the public map of HELM AI Kernel developer surfaces. It complements the quickstart and developer journey by showing where each source-backed capability lives in the repository and which public docs page owns the explanation.

Audience

This page is for developers who need the full HELM AI Kernel surface area without reading the repository directory by directory.

Outcome

You should be able to pick the correct page for installation, local execution, language SDKs, framework integration, deployment, schemas, conformance, verification, release integrity, and troubleshooting.

Surface Flow

flowchart TD
    subgraph Ingestion["1. Ingestion & Context Plane"]
        install["Install / build"]
        integrate["Integrate SDK or proxy"]
        deploy["Deploy or publish"]
        operate["Debug and conform"]
    end

    subgraph Evaluation["2. Evaluation & Policy Plane"]
        policy["Evaluate policy"]
    end

    subgraph Execution["3. Execution & Verdict Plane"]
        boundary["Run HELM boundary"]
    end

    subgraph Ledger["4. Tamper-Evident Ledger Plane"]
        receipt["Capture receipt"]
        verify["Verify evidence"]
    end

    %% Operational Flow Edges
    install --> boundary
    boundary --> integrate
    integrate --> policy
    policy --> receipt
    receipt --> verify
    verify --> deploy
    deploy --> operate

    %% Premium Styling Rules
    style boundary fill:#3182ce,stroke:#2b6cb0,stroke-width:2px,color:#fff
    style policy fill:#2d3748,stroke:#4a5568,stroke-width:2px,color:#fff
    style receipt fill:#2f855a,stroke:#276749,stroke-width:2px,color:#fff
    style verify fill:#2f855a,stroke:#276749,stroke-width:2px,color:#fff

flowchart TD
    subgraph Ingestion["1. Ingestion & Context Plane"]
        install["Install / build"]
        integrate["Integrate SDK or proxy"]
        deploy["Deploy or publish"]
        operate["Debug and conform"]
    end

    subgraph Evaluation["2. Evaluation & Policy Plane"]
        policy["Evaluate policy"]
    end

    subgraph Execution["3. Execution & Verdict Plane"]
        boundary["Run HELM boundary"]
    end

    subgraph Ledger["4. Tamper-Evident Ledger Plane"]
        receipt["Capture receipt"]
        verify["Verify evidence"]
    end

    %% Operational Flow Edges
    install --> boundary
    boundary --> integrate
    integrate --> policy
    policy --> receipt
    receipt --> verify
    verify --> deploy
    deploy --> operate

    %% Premium Styling Rules
    style boundary fill:#3182ce,stroke:#2b6cb0,stroke-width:2px,color:#fff
    style policy fill:#2d3748,stroke:#4a5568,stroke-width:2px,color:#fff
    style receipt fill:#2f855a,stroke:#276749,stroke-width:2px,color:#fff
    style verify fill:#2f855a,stroke:#276749,stroke-width:2px,color:#fff

Developer Surfaces

Source Truth

The coverage gate is docs/developer-coverage.manifest.json. The docs platform loads public pages from docs/public-docs.manifest.json, then validates that coverage-backed claims appear in public docs, search, Markdown exports, llms.txt, llms-full.txt, and MCP responses.

Troubleshooting

Surface Ownership Rules

The surface map is the index a maintainer checks before creating new public docs. Every meaningful code family should have exactly one owning doc, one validation command, and a decision about whether it is public direct, public hub, source-owner, generated/config, or private/internal. When a new directory, schema, SDK, example, or CLI command appears, update this map before adding marketing copy. The public site should expose supported developer paths; source-owner docs can carry implementation detail; generated/config rows can stay classified without standalone prose when they do not affect external workflows.

Treat missing ownership as a release blocker for high-value surfaces such as CLI commands, SDK packages, schemas, release artifacts, conformance fixtures, verifier paths, deployment examples, and policy bundles.

This map is also the first stop for deciding whether a new doc belongs in public IA or source-owner docs.