|
| 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 **hyperpolymath.github.io**. 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 SCM files MUST exist in `.machine_readable/` directory ONLY: |
| 17 | +1. **STATE.scm** - Project state, progress, blockers |
| 18 | +2. **META.scm** - Architecture decisions, governance |
| 19 | +3. **ECOSYSTEM.scm** - Position in ecosystem, relationships |
| 20 | +4. **AGENTIC.scm** - AI agent interaction patterns |
| 21 | +5. **NEUROSYM.scm** - Neurosymbolic integration config |
| 22 | +6. **PLAYBOOK.scm** - Operational runbook |
| 23 | + |
| 24 | +**CRITICAL:** If ANY of these files exist in the root directory, this is an ERROR. |
| 25 | + |
| 26 | +### Bot Directives: `.bot_directives/` ONLY |
| 27 | + |
| 28 | +Bot-specific instructions for: |
| 29 | +- rhodibot - Git operations |
| 30 | +- echidnabot - Code quality |
| 31 | +- sustainabot - Dependency updates |
| 32 | +- glambot - Documentation |
| 33 | +- seambot - Integration |
| 34 | +- finishbot - Task completion |
| 35 | + |
| 36 | +### Agent Instructions |
| 37 | + |
| 38 | +- `.claude/CLAUDE.md` - Claude-specific patterns (if exists) |
| 39 | +- `0-AI-MANIFEST.a2ml` - THIS FILE (universal entry point) |
| 40 | + |
| 41 | +## CORE INVARIANTS |
| 42 | + |
| 43 | +1. **No SCM duplication** - Root must NOT contain STATE.scm, META.scm, etc. |
| 44 | +2. **Single source of truth** - `.machine_readable/` is authoritative |
| 45 | +3. **No stale metadata** - If root SCMs exist, they are OUT OF DATE |
| 46 | +4. **License consistency** - All code PMPL-1.0-or-later unless platform requires MPL-2.0 |
| 47 | +5. **Author attribution** - Always "Jonathan D.A. Jewell <jonathan.jewell@open.ac.uk>" |
| 48 | + |
| 49 | +## REPOSITORY STRUCTURE |
| 50 | + |
| 51 | +<!-- CUSTOMIZE THIS SECTION FOR YOUR REPO --> |
| 52 | + |
| 53 | +This repo contains: |
| 54 | + |
| 55 | +``` |
| 56 | +hyperpolymath.github.io/ |
| 57 | +├── 0-AI-MANIFEST.a2ml # THIS FILE (start here) |
| 58 | +├── README.md # Project overview |
| 59 | +├── [your source files] # Main code |
| 60 | +├── .machine_readable/ # SCM files (6 files) |
| 61 | +│ ├── STATE.scm |
| 62 | +│ ├── META.scm |
| 63 | +│ ├── ECOSYSTEM.scm |
| 64 | +│ ├── AGENTIC.scm |
| 65 | +│ ├── NEUROSYM.scm |
| 66 | +│ └── PLAYBOOK.scm |
| 67 | +└── .bot_directives/ # Bot instructions |
| 68 | +``` |
| 69 | + |
| 70 | +## SESSION STARTUP CHECKLIST |
| 71 | + |
| 72 | +✅ Read THIS file (0-AI-MANIFEST.a2ml) first |
| 73 | +✅ Understand canonical locations (.machine_readable/, .bot_directives/) |
| 74 | +✅ Know the invariants (no SCM duplication, etc.) |
| 75 | +✅ Check for MCP enforcement (if applicable) |
| 76 | +✅ Read `.machine_readable/STATE.scm` for current status |
| 77 | +✅ Read `.machine_readable/AGENTIC.scm` for interaction patterns |
| 78 | + |
| 79 | +## LIFECYCLE HOOKS |
| 80 | + |
| 81 | +### on-enter (Session Start) |
| 82 | + |
| 83 | +When starting a new session: |
| 84 | + |
| 85 | +1. Read and acknowledge this manifest |
| 86 | +2. Log session start (optional but recommended) |
| 87 | + - Format: `[YYYY-MM-DD HH:MM:SS] Session started: [agent-name]` |
| 88 | + - Location: `.machine_readable/session-log.txt` |
| 89 | +3. Read `.machine_readable/STATE.scm` |
| 90 | +4. Check for blockers |
| 91 | +5. State understanding of canonical locations |
| 92 | + |
| 93 | +### on-exit (Session End) |
| 94 | + |
| 95 | +When ending a session: |
| 96 | + |
| 97 | +1. Update `.machine_readable/STATE.scm` if changes made |
| 98 | +2. Log session end (optional but recommended) |
| 99 | + - Format: `[YYYY-MM-DD HH:MM:SS] Session ended: [summary]` |
| 100 | + - Location: `.machine_readable/session-log.txt` |
| 101 | +3. Document new blockers |
| 102 | +4. Summarize outcomes |
| 103 | + |
| 104 | +## ATTESTATION PROOF |
| 105 | + |
| 106 | +After reading this file, demonstrate understanding by stating: |
| 107 | + |
| 108 | +**"I have read the AI manifest. SCM files are located in `.machine_readable/` ONLY, bot directives in `.bot_directives/`, and I will not create duplicate files in the root directory."** |
| 109 | + |
| 110 | +## META |
| 111 | + |
| 112 | +- **Format Version:** 1.0.0 |
| 113 | +- **Created:** [DATE] |
| 114 | +- **Maintained By:** [YOUR-NAME/ORG] |
| 115 | +- **License:** PMPL-1.0-or-later |
| 116 | +- **Protocol:** https://github.com/hyperpolymath/0-ai-gatekeeper-protocol |
0 commit comments