AkurAI-Framework / AGENTS.md

Latest change f3471263e31e8d4795fc55b99b3e5758bc428268 - docs: migrate dev/agent docs to akurai-notes MCP; CLAUDE.md->@AGENTS.md; AGENTS.md->pointer (site/content docs kept — served at runtime) by Ólafur Búi Ólafsson

# AGENTS.md — AkurAI-Framework

> Developer/agent documentation for this repo lives in the **akurai-notes** MCP,
> not in the repo. This file is a pointer only.

## Where the docs are

- **Canonical note:** `AkurAI-Framework — Docs` (note **49**) — the map (verbatim
  former `AGENTS.md`), the header/topology, and the sub-note index.
- **Index note:** `AkurAI EC2 — Documentation Index` (note **19**) — all AkurAI
  EC2 projects and their docs notes.
- **Per-domain sub-notes** (former `AGENTS_*.md` / `BATCHES.md` / `CHANGELOG.md` /
  `ISA.md`):
  - `AkurAI-Framework — Crates` (40) — the crate map (`AGENTS_CRATES.md`)
  - `AkurAI-Framework — Data Engine` (41) — `AGENTS_DATA.md`
  - `AkurAI-Framework — Frontend` (42) — `AGENTS_FRONTEND.md`
  - `AkurAI-Framework — Deploy` (43) — `AGENTS_DEPLOY.md`
  - `AkurAI-Framework — Testing` (44) — `AGENTS_TESTING.md`
  - `AkurAI-Framework — Doc Conventions` (45) — `AGENTS_DOCS.md`
  - `AkurAI-Framework — Batches` (46) — `BATCHES.md` (roadmap ledger)
  - `AkurAI-Framework — ISA` (47) — `ISA.md`
  - `AkurAI-Framework — Changelog` (48) — `CHANGELOG.md`

## How to retrieve

Use the akurai-notes MCP: `get_note(<id>)` for a specific note, or
`search_notes("AkurAI-Framework …")` to find one by topic. Start at note 49.

## Secrets

Credentials live in the **akurai-passvault** MCP (folder per repo) — never in the
repo or in notes. This repo has no committed secrets.

## Note: the framework's own public docs site stays in-repo

The framework's **public documentation website** content under `site/content/`
(`site/content/docs/*.md` and `site/content/changelog.md`) is **NOT** dev-docs and
was **not** migrated. The deployed binary serves it at runtime
(`akurai-framework.olibuijr.com/docs`, `/changelog`); it is build/runtime input.
Keep editing it in-repo, per the doc-with-every-feature and dual-changelog
policies (see note 45, `AkurAI-Framework — Doc Conventions`).