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_WORKFLOW.md).

Browse them locally in this folder, or read the rendered versions on the wiki — both reflect the same content.

Where to start

• New user → Quickstart · Troubleshooting · FAQ
• Evaluating the idea → Project Overview · Architecture · Comparison
• Understanding the harness → SLM Harness · Routes and Decisions · Semantic Preservation
• Operating PromptPilot → Authentication and Providers · Hybrid Mode · Tool Output Compression · Telemetry and Replay
• Contributing → Roadmap · Wiki Publishing

All pages

Topic	Local	Wiki
Project overview	PROJECT_OVERVIEW.md	Project-Overview
Architecture	ARCHITECTURE.md	Architecture
SLM harness	SLM_HARNESS.md	SLM-Harness
Routes and decisions	ROUTES_AND_DECISIONS.md	Routes-and-Decisions
Semantic preservation	SEMANTIC_PRESERVATION.md	Semantic-Preservation
Safety model	SAFETY_MODEL.md	Safety-Model
Authentication and providers	AUTHENTICATION_AND_PROVIDERS.md	Authentication-and-Providers
Hybrid mode (API + subscription)	HYBRID_MODE.md	Hybrid-Mode
Tool output compression	TOOL_OUTPUT_COMPRESSION.md	Tool-Output-Compression
Telemetry and replay	TELEMETRY_AND_REPLAY.md	Telemetry-and-Replay
Benchmarks	BENCHMARKS.md	Benchmarks
Comparison	COMPARISON.md	Comparison
FAQ	FAQ.md	FAQ
Troubleshooting	TROUBLESHOOTING.md	Troubleshooting
Roadmap	ROADMAP.md	Roadmap
Wiki publishing	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