From 5381ddd2c217c863cb5b894680b10f63ff0867bb Mon Sep 17 00:00:00 2001 From: Dani Date: Wed, 24 Jun 2026 16:59:08 -0400 Subject: [PATCH] docs: index all docs and add a Tutorials section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit index.md only linked 12 of the 19 docs under docs/. Readers entering from the index missed configuration, multimodal, demo, use-cases, benchmark, migration, and release notes. - Add a Tutorials section (Diátaxis 4th quadrant): everos-demo, use-cases - Reference: + configuration, + multimodal - How-to: + locomo_benchmark, + migration-to-1.0.0 - See also: + release-notes-1.1.0 Every docs/*.md (excluding the openapi.json artifact) is now linked. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/index.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/index.md b/docs/index.md index dbb21a54..eeee75ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,16 @@ Documentation for [EverOS](../README.md) — md-first memory extraction framework. Organised by [Diátaxis](https://diataxis.fr/) — what kind of question you have determines which section to read. +## Tutorials + +Learning-oriented entry points — start here to get a feel for the system +before wiring it into a real workflow. + +| Doc | Purpose | +|---|---| +| [everos-demo.md](everos-demo.md) | `everos demo` — local educational TUI to feel the memory lifecycle before configuring keys | +| [use-cases.md](use-cases.md) | Worked examples and integrations showing what persistent memory enables, to study and adapt | + ## Reference Technical reference: contracts, commands, schemas — read these when you @@ -15,6 +25,8 @@ already know what you want to do and need to know exactly how. | [knowledge.md](knowledge.md) | Knowledge base module — upload, search, taxonomy, storage layout | | [reflection.md](reflection.md) | Reflection — offline memory consolidation: enable, schedule, storage, triggering | | [cli.md](cli.md) | `everos` CLI subcommands + env var conventions | +| [configuration.md](configuration.md) | Two-file TOML configuration + environment-variable overrides for container deployments | +| [multimodal.md](multimodal.md) | Multimodal ingest — supported modalities, `uri` vs `base64` payloads, required extras/config | | [storage_layout.md](storage_layout.md) | Memory-root tree + frontmatter chassis + EntryId encoding | | [prompt_slots.md](prompt_slots.md) | YamlConfigLoader + three-layer prompt override | @@ -38,6 +50,8 @@ specific thing (drain a queue, recover from a stuck row, etc.). | Doc | Purpose | |---|---| | [cascade_runbook.md](cascade_runbook.md) | Cascade subsystem ops — drain queue, recover stuck rows | +| [locomo_benchmark.md](locomo_benchmark.md) | Reproduce EverOS's LoCoMo retrieval scores locally (`hybrid` / `agentic`) | +| [migration-to-1.0.0.md](migration-to-1.0.0.md) | Migrate off pre-1.0.0 APIs / infrastructure to the current 1.0.0 contract | ## Engineering / Internal @@ -56,6 +70,7 @@ Top-level project files live next to the repo root: - [QUICKSTART.md](../QUICKSTART.md) — 5-minute walkthrough (install → service → search) - [CONTRIBUTING.md](../CONTRIBUTING.md) — how to contribute (issue-only model) - [CHANGELOG.md](../CHANGELOG.md) — release notes +- [release-notes-1.1.0.md](release-notes-1.1.0.md) — EverOS 1.1.0 highlights (Knowledge, Reflection, OME) - [SECURITY.md](../SECURITY.md) — security policy & private vulnerability reporting - [CITATION.md](../CITATION.md) — academic citation info - [ACKNOWLEDGMENTS.md](../ACKNOWLEDGMENTS.md) — third-party acknowledgments