Skip to content

Thinklio Documentation

Consolidation in progress

The Thinklio docs are mid-way through a planned consolidation from 56 numbered files into 14 canonical documents. The full plan sits in CONSOLIDATION-PLAN.md at the repo root. This homepage is a placeholder and will be regenerated by scripts/build-doc-index.py once the canonical doc set lands.

What's here now

  • The MkDocs Material scaffold is live. You can serve the site locally with mkdocs serve from the repo root (install dependencies first: pip install -r docs/requirements.txt).
  • The docs/product/archive/ directory holds every original document from the pre-consolidation set, preserved with git history intact. See archive/README.md for the old-to-new mapping.
  • The docs/product/agent-specs/ directory is unchanged and remains the canonical home for individual agent specifications.

What's coming

The 14 consolidated docs, in the order they will land:

Number Title Merges old docs
01 Product & Strategy 01, 03, 22, 26, 38
02 System Architecture 04, 44, 54
03 Agent Architecture & Extensibility 15, 33, 37, 40, 42, 45, 46
04 Data Model 05, 32
05 Persistence, Storage & Ingestion 06, 20, 24, 41
06 Events, Channels & Messaging 07, 25, 27, 49
07 Security & Governance 08, 36, 47, 52
08 Agents Catalogue & Platform Services 19, 21, 30, 31
09 External API & Tool Integration 09, 16, 28, 51, 53
10 Client Applications & UX 12, 18, 23, 29
11 Convex Reference 43a, 48
12 Developer Guide 14, 35, 50, 55
13 Implementation Plan & Status 10, 34, 39
14 Thinklio Reference 17 (regenerated)

Plus the three living documents at this same level: changelog.md, decision-log.md, and this index.md.

Temporary pointers

Until each consolidated doc lands, the archived originals remain the working source of truth. Start with:

  • Archive mapping and recovery notes
  • Original index (archived): archive/old-numbering/00-document-index-v01.md
  • Original changelog (archived): archive/old-numbering/13-changelog-v02.md
  • Original decision log (archived): archive/old-numbering/11-decision-log-v02.md

Running the docs locally

# From repo root
pip install -r docs/requirements.txt
mkdocs serve
# Browse http://127.0.0.1:8000/

Questions

Raise anything odd in the consolidation effort as a comment on CONSOLIDATION-PLAN.md or drop it in decision-log.md once that file exists as a living doc.