From 7872b7cf95edbf7bba379e3b4007441441b5e791 Mon Sep 17 00:00:00 2001 From: Spencer Wozniak Date: Mon, 11 May 2026 22:45:24 -0700 Subject: [PATCH] docs: add per-feature reference notes for this branch MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit One markdown file per feature area introduced on this branch: - README.md — index - agentation.md — dev-only feedback overlay - chat-backend-integration.md — ChatWidget ↔ /api/chat - knowledge-base-ui.md — upload modal + KB browser - in-chat-command-routing.md — shared detectView() and the capability section of the chat system prompt - generation-endpoints.md — /api/generate/{flashcards,quiz} - audio-generation.md — /api/generate/audio + TTS playback - history-panel.md — live session list Each doc has a "Files touched" section so reviewers can map features to diffs quickly. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/README.md | 33 ++++++ docs/agentation.md | 38 +++++++ docs/audio-generation.md | 167 +++++++++++++++++++++++++++++++ docs/chat-backend-integration.md | 47 +++++++++ docs/generation-endpoints.md | 143 ++++++++++++++++++++++++++ docs/history-panel.md | 81 +++++++++++++++ docs/in-chat-command-routing.md | 74 ++++++++++++++ docs/knowledge-base-ui.md | 74 ++++++++++++++ 8 files changed, 657 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/agentation.md create mode 100644 docs/audio-generation.md create mode 100644 docs/chat-backend-integration.md create mode 100644 docs/generation-endpoints.md create mode 100644 docs/history-panel.md create mode 100644 docs/in-chat-command-routing.md create mode 100644 docs/knowledge-base-ui.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..73e4e11 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,33 @@ +# Sage docs + +Reference notes for changes made on this branch (`add-backend-requirements-txt`) +since the last commit on `main` (`92b46c8 build: add backend/requirements.txt`). +Each file documents one feature area: what was added, where it lives, and how +to use it. + +## Contents + +- [agentation-install.md](./agentation-install.md) — installing the Agentation + dev panel in the Next.js app. +- [chat-backend-integration.md](./chat-backend-integration.md) — wiring + `ChatWidget` to the live `/api/chat` endpoint (replaces the simulated reply). +- [knowledge-base-ui.md](./knowledge-base-ui.md) — the upload modal next to the + command bar and the `KnowledgeBaseWidget` for browsing ingested documents. +- [in-chat-command-routing.md](./in-chat-command-routing.md) — shared verb + detection so the command bar *and* the chat input both route "quiz", + "flashcards", "knowledge", etc. to the right view. +- [generation-endpoints.md](./generation-endpoints.md) — backend + `/api/generate/flashcards` and `/api/generate/quiz` plus the + `FlashcardsView` / `QuizView` wrappers that consume them. +- [audio-generation.md](./audio-generation.md) — `/api/generate/audio` + narration scripts, OpenAI TTS synthesis, and the dual-mode + `AudioPlayerWidget` (`