README.md

Docs Overview

This directory is the maintainer-facing landing page for repository docs. Use it to find the right guide quickly and keep public documentation aligned when the repo changes.

Start Here

• Repository overview
• Canonical concept model
• Copy-paste examples
• Change history

Using The Packages

• Python package guide
• TypeScript package guide
• Demo data notes

Integrating External Agents

• External agent integration guide
• Python and TypeScript extension hooks
• Sandbox and executor notes
• MLX host training notes

Contributing And Support

• Contributing guide
• Agent guide
• Support
• Security policy

Architecture And Parity

• Core/control package split
• Scenario parity matrix — Python & TypeScript
• Browser exploration contract

Execution Surfaces (0.3.0)

• simulate — modeled-world exploration with sweeps, replay, compare, export
• investigate — evidence-driven diagnosis in synthetic harness or iterative LLM modes
• analyze — interpret and compare outputs from all surfaces
• mission — real-world goal execution with adaptive planning and campaigns
• train — distill curated datasets into scenario-local models

Trace Pipeline (0.3.0)

• Public trace schema v1.0.0 for cross-harness interchange
• Privacy-aware export with sensitive-data redaction (21 patterns)
• Publishing to local JSONL, GitHub Gist, Hugging Face (ShareGPT format)
• Dataset curation with gate filtering, top-quartile selection, held-out splits
• Model selection strategy (from-scratch / LoRA / full fine-tune)
• Training backends (MLX / CUDA) with promotion lifecycle

Maintainer Docs

• Analytics and adoption guide
• Release checklist

Keep These In Sync

If a change affects commands, package names, published versions, environment variables, agent integration flows, or support expectations, review these docs in the same PR:

• README.md
• autocontext/README.md
• ts/README.md
• examples/README.md
• autocontext/docs/agent-integration.md
• CHANGELOG.md
• SUPPORT.md