Files
EverOS/docs/index.md
T
DaniandClaude Sonnet 4.6 648b34b22c docs: add multimodal memory guide (#278)
* docs: add multimodal memory guide

Add docs/multimodal.md covering the full multimodal ingest flow:
supported modalities, prerequisites, payload formats (uri / base64 /
file://), configuration reference, error semantics, and search.
Wire it into docs/index.md under the How-to section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci: retrigger integration tests

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-10 09:55:39 +08:00

2.8 KiB

EverOS Documentation

Documentation for EverOS — md-first memory extraction framework. Organised by Diátaxis — what kind of question you have determines which section to read.

Reference

Technical reference: contracts, commands, schemas — read these when you already know what you want to do and need to know exactly how.

Doc Purpose
api.md HTTP API v1 reference — endpoints, request / response, error contracts
cli.md everos CLI subcommands + env var conventions
storage_layout.md Memory-root tree + frontmatter chassis + EntryId encoding
prompt_slots.md YamlConfigLoader + three-layer prompt override
migration-to-1.0.0.md Legacy API and infrastructure migration notes for EverOS 1.0.0

Explanation

Design decisions and architectural concepts — read these to understand why the system is shaped the way it is.

Doc Purpose
overview.md Project vision, scope, design philosophy
how-memory-works.md Storage stack + on-disk paths + write→index→read pipeline + consistency
architecture.md DDD layered architecture + dependency rules
datetime.md Two-zone discipline — UTC at storage, display tz at boundaries

How-to

Task-driven operational guides — read these when you need to do a specific thing (drain a queue, recover from a stuck row, etc.).

Doc Purpose
cascade_runbook.md Cascade subsystem ops — drain queue, recover stuck rows
multimodal.md Ingest images, PDFs, audio, and office docs into memory

Engineering / Internal

For maintainers and contributors working on the framework itself, not for using it.

Doc Purpose
engineering.md Engineering & dev-efficiency infrastructure (CI / tooling / Claude Code)

See also

Top-level project files live next to the repo root:

Coding conventions and slash command workflows are auto-loaded by Claude Code from .claude/rules/ and .claude/skills/.