Home

PromptPilot Docs Index

These markdown files are the source of truth for PromptPilot's long-form documentation. The GitHub Wiki is an auto-published mirror, regenerated from this folder by scripts/publish_wiki.sh (see Wiki Publishing).

Browse them locally in this folder, or read the rendered versions on the wiki — both reflect the same content. Links below use absolute URLs so they resolve the same whether you're reading this page in the repo or on the wiki.

What's new in v0.3.1

• Tool-aware session strategy — PromptPilot now picks the cheaper session mechanism per tool: bound the session on codex, use native --resume (rewrite-only) on claude. Same code/task/SLM, opposite verdict — see Session Memory and Benchmarks.
• Autonomous clarify-route guard — with PROMPTPILOT_AUTONOMOUS=1, a route=clarify decision degrades to act instead of emitting a human-style clarifying question, so an agent acts rather than answering itself. Interactive CLI behavior is unchanged. See Routes and Decisions.

Where to start

• New user → Quickstart · Troubleshooting · FAQ
• Evaluating the idea → Project Overview · Architecture · Comparison
• Judging the numbers → Benchmarks · Testing Strategy & journey · Measurement Methodology
• Understanding the harness → SLM Harness · Routes and Decisions · Session Memory · Semantic Preservation
• Operating PromptPilot → Authentication and Providers · Hybrid Mode · Tool Output Compression · Telemetry and Replay
• Contributing → Roadmap · Wiki Publishing

All pages

Topic	Repo source	Wiki page
Project overview	docs/PROJECT_OVERVIEW.md	Project-Overview
Architecture	docs/ARCHITECTURE.md	Architecture
SLM harness	docs/SLM_HARNESS.md	SLM-Harness
Routes and decisions	docs/ROUTES_AND_DECISIONS.md	Routes-and-Decisions
Session memory	docs/SESSION_MEMORY.md	Session-Memory
Semantic preservation	docs/SEMANTIC_PRESERVATION.md	Semantic-Preservation
Safety model	docs/SAFETY_MODEL.md	Safety-Model
Authentication and providers	docs/AUTHENTICATION_AND_PROVIDERS.md	Authentication-and-Providers
Hybrid mode (API + subscription)	docs/HYBRID_MODE.md	Hybrid-Mode
Tool output compression	docs/TOOL_OUTPUT_COMPRESSION.md	Tool-Output-Compression
Telemetry and replay	docs/TELEMETRY_AND_REPLAY.md	Telemetry-and-Replay
Benchmarks	docs/BENCHMARKS.md	Benchmarks
Testing strategy & journey	docs/TESTING_STRATEGY.md	Testing-Strategy
Measurement methodology	docs/MEASUREMENT_METHODOLOGY.md	Measurement-Methodology
Comparison	docs/COMPARISON.md	Comparison
FAQ	docs/FAQ.md	FAQ
Troubleshooting	docs/TROUBLESHOOTING.md	Troubleshooting
Roadmap	docs/ROADMAP.md	Roadmap
Wiki publishing	docs/WIKI_WORKFLOW.md	Wiki-Publishing

Top-level files

These live at the repo root, not in docs/, because they're operational rather than long-form:

• README.md — project overview and install
• QUICKSTART.md — five-minute onboarding
• SECURITY.md — key handling and security policy
• CONTRIBUTING.md — contribution workflow
• CODE_OF_CONDUCT.md — community guidelines