Files

Elliot Chen 518b8eca85 chore: initialize EverOS 1.0.0

md-first memory extraction framework for AI agents.

Markdown is the single source of truth; SQLite holds state and LanceDB
provides the rebuildable vector + BM25 + scalar index. The codebase follows
a single-direction DDD layering (entrypoints -> service -> memory -> infra,
with component / core / config cross-cutting) enforced by import-linter.

Engineering surface:
- Coding conventions in .claude/rules/ (path-scoped) and workflows in
  .claude/skills/ (/commit, /new-branch, /pr).
- GitHub Actions CI runs make lint + test + integration; pre-commit mirrors
  the gates locally (ruff, hygiene hooks, gitlint commit-msg).
- Commit messages follow Conventional Commits, enforced by gitlint.
- make lint also enforces datetime two-zone discipline and OpenAPI drift.

2026-06-06 07:33:17 +08:00

2.5 KiB

Raw Blame History

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

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

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)

2.5 KiB Raw Blame History