Home

PromptPilot Docs Index

PromptPilot keeps repository docs intentionally small and uses the GitHub Wiki for long-form product, workflow, and evaluation material.

Use the GitHub Wiki for long-form docs

• Wiki home: https://github.com/steyangdot/PromptPilot/wiki

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 docs: Roadmap -> Wiki Publishing

Wiki pages

• Project Overview
• Quickstart
• Authentication and Providers
• Hybrid Mode
• Tool Output Compression
• Troubleshooting
• Architecture
• SLM Harness
• Routes and Decisions
• Semantic Preservation
• Safety Model
• Telemetry and Replay
• Benchmarks
• Comparison
• FAQ
• Roadmap
• Wiki Publishing

What remains in-repo

• README.md for project overview and install
• QUICKSTART.md for five-minute onboarding
• SECURITY.md for key-handling and security policy
• CONTRIBUTING.md for contribution workflow
• WIKI_WORKFLOW.md for the wiki sync script and usage