0-AI-MANIFEST.a2ml

# SPDX-License-Identifier: MPL-2.0
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>

# STOP - CRITICAL READING REQUIRED

**THIS FILE MUST BE READ FIRST BY ALL AI AGENTS**

## WHAT IS THIS?

This is the AI manifest for **mylangiser** -- a progressive-disclosure
interface generator. Mylangiser analyses complex API surfaces, assigns
cognitive-load complexity scores, and generates layered wrappers at three
disclosure levels (@beginner, @intermediate, @expert) using My-Lang.

Part of the hyperpolymath **-iser family** (https://github.com/hyperpolymath/iseriser).

## CANONICAL LOCATIONS (UNIVERSAL RULE)

### Machine-Readable Metadata: `.machine_readable/` ONLY

These 6 a2ml files MUST exist in `.machine_readable/6a2/` directory ONLY:
1. **STATE.a2ml** - Project state, progress, blockers
2. **META.a2ml** - Architecture decisions, governance
3. **ECOSYSTEM.a2ml** - Position in ecosystem, relationships
4. **AGENTIC.a2ml** - AI agent interaction patterns
5. **NEUROSYM.a2ml** - Neurosymbolic integration config
6. **PLAYBOOK.a2ml** - Operational runbook

**CRITICAL:** If ANY of these files exist in the root directory, this is an ERROR.

### Anchor File: `.machine_readable/anchors/ANCHOR.a2ml` ONLY

Canonical authority and semantic-boundary declaration MUST exist at:

` .machine_readable/anchors/ANCHOR.a2ml `

Do not place `ANCHOR.a2ml` at repository root.

### Maintenance Policies: `.machine_readable/policies/` ONLY

Canonical maintenance/governance files MUST exist under:

` .machine_readable/policies/ `

Minimum required files:
- `MAINTENANCE-AXES.a2ml`
- `MAINTENANCE-CHECKLIST.a2ml`
- `SOFTWARE-DEVELOPMENT-APPROACH.a2ml`

Do not place maintenance policy files in repository root.

### Bot Directives: `.machine_readable/bot_directives/` ONLY

Bot-specific instructions for your automated agents.

### Contractiles: `.machine_readable/contractiles/` ONLY

Policy enforcement contracts (k9, dust, lust, must, trust).

### AI Configuration & Guides: `.machine_readable/ai/` ONLY

- `AI.a2ml` - Language-specific or LLM-specific patterns
- `PLACEHOLDERS.adoc` - Bootstrap guide

### Community & Forge Metadata: `.github/` ONLY

- `CODEOWNERS` - Review assignments
- `MAINTAINERS` - Machine-readable contact list
- `SUPPORT` - Support channels
- `SECURITY.md` - Technical security policy
- `CONTRIBUTING.md` - Technical contribution manual
- `CODE_OF_CONDUCT.md` - Conduct rules

### Agent Instructions

- `0-AI-MANIFEST.a2ml` - THIS FILE (universal entry point)

## CORE INVARIANTS

1. **No state file duplication** - Root must NOT contain STATE.a2ml, META.a2ml, etc.
2. **Single source of truth** - `.machine_readable/` is authoritative
3. **No stale metadata** - If root state files exist, they are OUT OF DATE
4. **License consistency** - All code MPL-2.0 unless platform requires MPL-2.0
5. **Author attribution** - Always "Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>"
6. **Container images** - MUST use Chainguard base (`cgr.dev/chainguard/wolfi-base:latest` or `cgr.dev/chainguard/static:latest`)
7. **Container runtime** - Podman, never Docker. Files are `Containerfile`, never `Dockerfile`
8. **Container orchestration** - `selur-compose`, never `docker-compose`

## REPOSITORY STRUCTURE

```
mylangiser/
├── 0-AI-MANIFEST.a2ml         # THIS FILE (start here)
├── README.adoc                 # What mylangiser does, architecture, My-Lang specifics
├── ROADMAP.adoc                # Phase 0-6: scaffold through ecosystem
├── CONTRIBUTING.adoc           # Contribution guide
├── Justfile                    # Task runner
├── Cargo.toml                  # Rust CLI build
├── Containerfile               # OCI build (Chainguard base)
├── LICENSE                     # MPL-2.0
├── src/                        # Source code
│   ├── main.rs                 # CLI entry point (init, validate, generate, build, run, info)
│   ├── lib.rs                  # Library interface
│   ├── manifest/               # mylangiser.toml parser
│   ├── codegen/                # My-Lang layer generation
│   └── interface/              # Verified Interface Seams
│       ├── abi/                # Idris2 ABI (Types, Layout, Foreign)
│       │   ├── Types.idr       # DisclosureLevel, ComplexityScore, APIEndpoint, LayeredWrapper, SmartDefault
│       │   ├── Layout.idr      # APISurfaceDescriptor, EndpointDescriptor, WrapperDescriptor layouts
│       │   └── Foreign.idr     # FFI declarations: analysis, scoring, layer generation
│       ├── ffi/                # Zig FFI (C-ABI bridge)
│       │   ├── build.zig       # Build config for libmylangiser
│       │   ├── src/main.zig    # FFI implementation
│       │   └── test/           # Integration tests
│       └── generated/          # Auto-generated C headers
├── container/                  # Stapeln container ecosystem
├── docs/                       # Technical documentation
└── .machine_readable/          # ALL machine-readable metadata
    └── 6a2/                    # STATE, META, ECOSYSTEM, AGENTIC, NEUROSYM, PLAYBOOK
```

## DOMAIN CONCEPTS

- **Disclosure level**: @beginner / @intermediate / @expert -- controls how much
  of an API is visible to the consumer
- **Complexity score**: 0-100 cognitive-load rating per endpoint
- **Smart default**: safe inferred value for an optional parameter (enum-first,
  numeric-lower, doc-annotated, user-provided)
- **Layered wrapper**: generated interface that exposes different parameter sets
  at each disclosure level
- **API surface analysis**: scanning an API to count endpoints, parameters, type
  depth, and error surface area

## SESSION STARTUP CHECKLIST

Read THIS file (0-AI-MANIFEST.a2ml) first
Understand canonical location: `.machine_readable/`
State understanding of canonical locations

## ATTESTATION PROOF

**"I have read the AI manifest for mylangiser. All machine-readable content
(state files, anchors, policies, bot directives, contractiles, AI guides) is
located in `.machine_readable/` ONLY, and community metadata is in `.github/`.
I will not create duplicate files in the root directory."**