This folder is the public documentation map for AIppocampus. Runtime contracts
for the installable skill live under skills/aippocampus/references/; this
folder carries product direction, architecture, guides, evidence, planning, and
research notes.
Start with start-here.md when you are choosing a reader path.
Use this page only as the folder map.
| Reader | First stop |
|---|---|
| I just want to install and see one recall moment. | start-here.md#first-recall |
| I want to see my memory or leave a small agent note. | start-here.md#see-and-add-to-memory |
| I am evaluating AIppocampus for coding-agent work. | start-here.md#coding-agent-user |
| I am changing runtime, search, hooks, or sync. | start-here.md#maintainer |
| I am lost in the newer architecture concepts. | architecture/source-shape-runtime-spine.md |
| I am checking benchmark or release claims. | start-here.md#benchmark-or-claim-reviewer |
| I am exploring the broader continuity idea. | start-here.md#continuity-and-research-reader |
The default product language is import, recall, and carry the source forward.
Use roadmap.md#product-layers and
guides/public-core-boundary.md#core-complexity-budget
before promoting a heavier mechanism into the ordinary user path.
| Folder | Owner | Use |
|---|---|---|
guides/ |
guides/README.md |
User setup, public boundaries, release/operator how-to, and community paths. |
architecture/ |
architecture/README.md |
Current contracts, implementation maps, inventories, active designs, and research seeds. |
evidence/ |
evidence/README.md |
Current claims, product/human evidence, benchmark maps, dated ledgers, and field reports. |
planning/ |
planning/README.md |
Active handoffs, follow-up RFCs, and planning audit notes. |
research/ |
research/README.md |
Speculative research notes, evidence levels, and long-garden seeds. |
archive/ |
archive/README.md |
Historical, superseded, or one-off working material with current-owner pointers. |
roadmap.md- product north star, layers, and stage direction.agent-context.md- compact agent-readable truth pack for recommending, installing, comparing, or invoking AIppocampus.未干的地图.md- canonical Chinese origin essay; do not mirror its full text elsewhere.the-unfinished-map.md- English transcreation of the origin essay.
Keep long rules, status matrices, and command logs in one authoritative place. Other docs should link to that place and add only local context.
When two docs appear to disagree, prefer the current runtime contract or the
owner issue named by the local folder index. Research notes preserve design
context; they do not override skills/aippocampus/, docs/architecture/, or
the current evidence ledger.
These links stay visible here because docs-health checks treat them as critical navigation anchors, even though their detailed inventories live in local indexes.
| Boundary | Owner |
|---|---|
| Benchmark map | evidence/benchmark-evidence-map.md |
| Proof-slice maturity | evidence/readiness/proof-slice-maturity.md |
| Source-backed kernel contract | architecture/architecture-overview.md#source-backed-kernel-contract |
| Foreground product discipline | architecture/recall/source-backed-product-discipline.md |
| Product profile boundary | architecture/host/product-profiles.md |
| Legacy alias inventory | architecture/ops/legacy-alias-inventory.md |
| Path identity | architecture/source/path-identity.md |
| Clean-source redaction profiles | architecture/source/clean-source-redaction-profiles.md |
| Dependency contract | guides/setup/dependency-contract.md |
| Safe environment | guides/setup/safe-environment.md |
Do not place raw rollouts, generated indexes, private anchors, registry exports,
or local-machine paths in this docs folder. Generated memory artifacts belong in
the configured AIppocampus registry by default
(AIPPOCAMPUS_REGISTRY_DIR, AIPPOCAMPUS_HOME/registry, then legacy
$CODEX_HOME/aippocampus-registry), or in explicit local export/debug paths
that stay gitignored.
Public benchmark-corpus scripts and curated samples live in
benchmark_corpus/. Keep local caches, generated outputs, benchmark reports,
and private exports out of git unless a future change deliberately promotes a
small public subset with provenance.