docs/

July 15, 2026 · View on GitHub

Master index for all documentation in the harness-kit monorepo.

Where things go

TypeLocationPurposeCreated by
Breadcrumbsbreadcrumb_analysis/End-to-end flow traces (FLOW + DETAILS + DEBUG)/hk-breadcrumb-creator
Solutionssolutions/<category>/Compounded learnings (legacy — new entries land in patterns/ via /hk-compound)Manual
Philosophyphilosophy/Core design principles that govern how we buildManual
Testing processtesting_process/Testing framework, RCA protocol, test categoriesManual
Guidesguides/Operational how-tos — deployment, building MCPsManual

Sub-indexes

  • breadcrumb_analysis/_INDEX.md — all flow traces + symptom quick-nav
  • solutions/ — organized by category (currently workflow-issues/)

Current contents

21 flow traces covering Odin lifecycle + supporting systems. See breadcrumb_analysis/_INDEX.md for full list and symptom quick-nav.

solutions/

2 compounded learnings. Browse by directory.

philosophy/

  • testing.md — single source of truth for derived data, what to test where

testing_process/

  • testcase_process_and_philosophy.md — full testing framework, TDD wave pattern, RCA protocol
  • testing_end_to_end.md — test layers (unit/mock/snapshot/e2e), diagnostic scripts, snapshot workflow

guides/

  • deployment.md — deploying taskit-backend, taskit-frontend, odin across environments
  • forkd-setup.md — configuring forkd microVM sandbox execution for Odin agents
  • mcp_building.md — creating MCP servers in Python (FastMCP) or Node/TypeScript