Skip to content

README.md

Latest commit

 

History

History
37 lines (28 loc) · 2.04 KB

README.md

File metadata and controls

37 lines (28 loc) · 2.04 KB
Raw

Engineering Docs

This directory contains the engineering-facing markdown for the public main branch.

These docs are for people who want to run, inspect, modify, or extend the local edition.

Product-facing website/FAQ source lives in site_faq/. It is grouped here to keep markdown docs in one place, but it is not the same thing as the engineering docs below.

Recommended reading order

  1. Local Quickstart
  2. Architecture
  3. Agentic Loop
  4. Provider Guide
  5. Usage Guide
  6. Obsidian Bridge
  7. MCP Setup
  8. Latest release
  9. Architecture Decision Records
  10. Site FAQ source

What each file is for

  • Local Quickstart: exact setup, reset, and local runtime workflow
  • Architecture: repository structure, boundaries, domain model, and service layout
  • Agentic Loop: the decision and apply loop behind chat, proposals, quizzes, and rollback
  • Provider Guide: built-in providers, model config, and how to add another provider cleanly
  • Usage Guide: source-material guidance for generating high-quality ingest input
  • Obsidian Bridge: import an Obsidian vault into Clew or export a graph back into Markdown
  • MCP Setup: connect Clew Study Assist to Claude Desktop, Claude Code, or Cursor via the built-in MCP server
  • Latest release: release notes live on GitHub
  • ADR index: long-lived decisions, including why external bridges must preserve the graph boundary
  • Site FAQ source: product-facing pages used by the hosted docs/site surface

What is intentionally not here

This directory is not meant to become a graveyard of speculative product plans. It should stay close to code that actually exists in main.