0a99922f24
* docs: add EverMind ecosystem overview * docs: move ecosystem overview lower * docs: add EverOS 1.0.0 highlights * docs: streamline README flow * docs: refine README showcase layout * docs: update README banner image * docs: use uploaded README banner * docs: expand README highlights and navigation * docs: normalize README title capitalization * docs: align EverOS description with banner * docs: use high-density README banner * docs: clarify EverOS overview * docs: add README localization and star history * docs: expand Chinese README localization
2.7 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 |
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:
- README.md — quick start & feature overview
- QUICKSTART.md — 5-minute walkthrough (install → service → search)
- use-cases.md — full use-case gallery and integration examples
- CONTRIBUTING.md — how to contribute (issue-only model)
- CHANGELOG.md — release notes
- SECURITY.md — security policy & private vulnerability reporting
- CITATION.md — academic citation info
- ACKNOWLEDGMENTS.md — third-party acknowledgments
Coding conventions and slash command workflows are auto-loaded by Claude Code from .claude/rules/ and .claude/skills/.