|
| 1 | +# ⚠️ STOP - CRITICAL READING REQUIRED |
| 2 | + |
| 3 | +**THIS FILE MUST BE READ FIRST BY ALL AI AGENTS** |
| 4 | + |
| 5 | +## WHAT IS THIS? |
| 6 | + |
| 7 | +This is the AI manifest for **[YOUR-REPO-NAME]**. It declares: |
| 8 | +- Canonical file locations (where things MUST be, and nowhere else) |
| 9 | +- Critical invariants (rules that must NEVER be violated) |
| 10 | +- Repository structure and organization |
| 11 | + |
| 12 | +## CANONICAL LOCATIONS (UNIVERSAL RULE) |
| 13 | + |
| 14 | +### Machine-Readable Metadata: `.machine_readable/` ONLY |
| 15 | + |
| 16 | +These 6 a2ml files MUST exist in `.machine_readable/` directory ONLY: |
| 17 | +1. **STATE.a2ml** - Project state, progress, blockers |
| 18 | +2. **META.a2ml** - Architecture decisions, governance |
| 19 | +3. **ECOSYSTEM.a2ml** - Position in ecosystem, relationships |
| 20 | +4. **AGENTIC.a2ml** - AI agent interaction patterns |
| 21 | +5. **NEUROSYM.a2ml** - Neurosymbolic integration config |
| 22 | +6. **PLAYBOOK.a2ml** - Operational runbook |
| 23 | + |
| 24 | +**CRITICAL:** If ANY of these files exist in the root directory, this is an ERROR. |
| 25 | + |
| 26 | +### Anchor File: `.machine_readable/anchors/ANCHOR.a2ml` ONLY |
| 27 | + |
| 28 | +Canonical authority and semantic-boundary declaration MUST exist at: |
| 29 | + |
| 30 | +` .machine_readable/anchors/ANCHOR.a2ml ` |
| 31 | + |
| 32 | +Do not place `ANCHOR.a2ml` at repository root. |
| 33 | + |
| 34 | +### Maintenance Policies: `.machine_readable/policies/` ONLY |
| 35 | + |
| 36 | +Canonical maintenance/governance files MUST exist under: |
| 37 | + |
| 38 | +` .machine_readable/policies/ ` |
| 39 | + |
| 40 | +Minimum required files: |
| 41 | +- `MAINTENANCE-AXES.a2ml` |
| 42 | +- `MAINTENANCE-CHECKLIST.a2ml` |
| 43 | +- `SOFTWARE-DEVELOPMENT-APPROACH.a2ml` |
| 44 | + |
| 45 | +Do not place maintenance policy files in repository root. |
| 46 | + |
| 47 | +### Bot Directives: `.machine_readable/bot_directives/` ONLY |
| 48 | + |
| 49 | +Bot-specific instructions for your automated agents. |
| 50 | + |
| 51 | +### Contractiles: `.machine_readable/contractiles/` ONLY |
| 52 | + |
| 53 | +Policy enforcement contracts (k9, dust, lust, must, trust). |
| 54 | + |
| 55 | +### AI Configuration & Guides: `.machine_readable/ai/` ONLY |
| 56 | + |
| 57 | +- `AI.a2ml` - Language-specific or LLM-specific patterns |
| 58 | +- `PLACEHOLDERS.md` - Bootstrap guide |
| 59 | + |
| 60 | +### Community & Forge Metadata: `.github/` ONLY |
| 61 | + |
| 62 | +- `CODEOWNERS` - Review assignments |
| 63 | +- `MAINTAINERS` - Machine-readable contact list |
| 64 | +- `SUPPORT` - Support channels |
| 65 | +- `SECURITY.md` - Technical security policy |
| 66 | +- `CONTRIBUTING.md` - Technical contribution manual |
| 67 | +- `CODE_OF_CONDUCT.md` - Conduct rules |
| 68 | + |
| 69 | +### Agent Instructions |
| 70 | + |
| 71 | +- `0-AI-MANIFEST.a2ml` - THIS FILE (universal entry point) |
| 72 | + |
| 73 | +## CORE INVARIANTS |
| 74 | + |
| 75 | +1. **No state file duplication** - Root must NOT contain STATE.a2ml, META.a2ml, etc. |
| 76 | +2. **Single source of truth** - `.machine_readable/` is authoritative |
| 77 | +3. **No stale metadata** - If root state files exist, they are OUT OF DATE |
| 78 | +4. **License consistency** - All code PMPL-1.0-or-later unless platform requires MPL-2.0 |
| 79 | +5. **Author attribution** - Always "Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>" |
| 80 | +6. **Container images** - MUST use Chainguard base (`cgr.dev/chainguard/wolfi-base:latest` or `cgr.dev/chainguard/static:latest`) |
| 81 | +7. **Container runtime** - Podman, never Docker. Files are `Containerfile`, never `Dockerfile` |
| 82 | +8. **Container orchestration** - `selur-compose`, never `docker-compose` |
| 83 | + |
| 84 | +## REPOSITORY STRUCTURE |
| 85 | + |
| 86 | +This repo follows the **Dual-Track** architecture: |
| 87 | + |
| 88 | +``` |
| 89 | +[YOUR-REPO-NAME]/ |
| 90 | +├── 0-AI-MANIFEST.a2ml # THIS FILE (start here) |
| 91 | +├── README.adoc # High-level orientation (Rich Human) |
| 92 | +├── ROADMAP.adoc # Future direction |
| 93 | +├── CONTRIBUTING.adoc # Human contribution guide |
| 94 | +├── GOVERNANCE.adoc # Decision-making model |
| 95 | +├── Justfile # Task runner |
| 96 | +├── Containerfile # OCI build |
| 97 | +├── LICENSE # Primary license |
| 98 | +├── src/ # Source code |
| 99 | +│ └── interface/ # Verified Interface Seams |
| 100 | +│ ├── abi/ # Idris2 ABI (The Spec) |
| 101 | +│ ├── ffi/ # Zig FFI (The Bridge) |
| 102 | +│ └── generated/ # C Headers (The Result) |
| 103 | +├── container/ # Stapeln container ecosystem |
| 104 | +├── docs/ # Technical depths |
| 105 | +│ ├── attribution/ # Citations, owners, maintainers (adoc) |
| 106 | +│ ├── architecture/ # Topology, diagrams |
| 107 | +│ ├── theory/ # Domain theory |
| 108 | +│ └── practice/ # Manuals |
| 109 | +├── docs/legal/ # Legal exhibits and full texts |
| 110 | +└── .machine_readable/ # ALL machine-readable metadata |
| 111 | +``` |
| 112 | + |
| 113 | +## SESSION STARTUP CHECKLIST |
| 114 | + |
| 115 | +✅ Read THIS file (0-AI-MANIFEST.a2ml) first |
| 116 | +✅ Understand canonical location: `.machine_readable/` |
| 117 | +✅ State understanding of canonical locations |
| 118 | + |
| 119 | +## ATTESTATION PROOF |
| 120 | + |
| 121 | +**"I have read the AI manifest. 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."** |
0 commit comments