--- title: "Documentation & Knowledge Base" description: "Navigate TurboPentest's documentation system powered by Fumadocs, leverage AI-powered search, and use llms.txt for programmatic access by AI assistants." canonical: https://turbopentest.com/learn/ecosystem/documentation source: "TurboPentest Learn" --- # Documentation & Knowledge Base ## The TurboPentest Documentation System TurboPentest's documentation is built on Fumadocs, a modern documentation framework that provides fast search, structured navigation, and excellent readability. The docs serve as the primary knowledge base for everything from getting started to advanced integration patterns. ### Navigating the Documentation The documentation is organized into several key sections: - **Getting Started** - Account setup, first pentest walkthrough, and basic concepts - **Platform Guide** - Detailed coverage of all TurboPentest features, configurations, and workflows - **API Reference** - Complete REST API documentation with request/response examples for every endpoint - **Integration Guides** - Step-by-step setup for GitHub Actions, MCP Server, Slack, Jira, and custom webhooks - **Tool Reference** - Documentation for each of the 14 Phase 1 tools, including what they test and how to interpret their output - **Agent Reference** - Documentation for each Paladin specialist agent, including their focus areas and the types of findings they produce - **FAQ** - Answers to common questions about billing, security, compliance, and troubleshooting ### Search The documentation includes full-text search powered by Fumadocs' built-in search engine. Search works across all sections and returns results ranked by relevance. Use specific terms (e.g., "Jira webhook setup") rather than broad queries for the best results. ## AI-Powered Documentation Access ### The llms.txt Standard TurboPentest implements the `llms.txt` standard - a structured file at `https://turbopentest.com/llms.txt` that provides AI assistants with a machine-readable index of all documentation content. This means any AI assistant (Claude, ChatGPT, Copilot, etc.) can be pointed to this URL to gain comprehensive knowledge about TurboPentest. The `llms.txt` file contains: - A structured overview of TurboPentest's capabilities - Links to every documentation page with descriptions - API endpoint summaries - Common workflow patterns ### How llms.txt Works When you ask an AI assistant a question about TurboPentest, it can fetch `llms.txt` to understand the full scope of the platform. This is more effective than the assistant trying to answer from its training data alone, because: 1. **Always current** - The file is updated with every documentation change 2. **Comprehensive** - It covers every feature, not just what the model was trained on 3. **Structured** - The format is optimized for AI consumption, not human browsing ### Using llms.txt with Your AI Assistant To leverage this in practice: **In Claude Code or similar:** ``` "Read https://turbopentest.com/llms.txt and then help me set up a scheduled pentest" ``` **In the MCP Server context:** The TurboPentest MCP Server automatically includes relevant documentation context when you ask questions, drawing from the same knowledge base. ### llms-full.txt For AI assistants that can handle larger contexts, `https://turbopentest.com/llms-full.txt` provides the complete documentation content in a single file rather than just an index with links. This enables assistants to answer detailed questions without making additional HTTP requests. ## Documentation Versioning The documentation is maintained alongside the TurboPentest platform: when new features are released, documentation is updated at the same time so the published docs always reflect the current platform. > **Roadmap - version dropdown.** A user-facing version dropdown for browsing docs from a previous release is not currently available. The published documentation tracks the live platform; there is no archived-version selector today. ### Changelog Platform changes are tracked in an internal, admin-only changelog. There is currently **no public changelog route** (no `/learn/changelog` page) and **no changelog RSS feed** - both are planned but not yet shipped. For now, keep up with new features, API changes, and deprecations via the `#changelog` and `#announcements` channels in the Discord community and the release notes in the docs. ## Contributing to Documentation TurboPentest's documentation is open source. If you find an error, want to add a guide, or improve an explanation: 1. Click the "Edit on GitHub" link on any documentation page 2. Fork the repository and make your changes 3. Submit a pull request with a description of your improvement Documentation contributions are reviewed by the TurboPentest team and merged within one business day for minor corrections. Significant additions may involve collaborative editing. ### Documentation Style When contributing, follow these guidelines: - **Task-oriented** - Structure content around what the user is trying to accomplish - **Code examples** - Include working code examples for every technical concept - **Progressive disclosure** - Start with the simplest case and add complexity gradually - **No jargon without definition** - Define technical terms the first time they appear ## Self-Hosting Documentation For enterprise customers operating in air-gapped environments, the documentation can be self-hosted. The Fumadocs-based documentation site is a standard Next.js application that can be built and deployed to any internal server. ```bash git clone https://github.com/turbopentest/docs.git cd docs npm install npm run build npm start ``` This gives your team full documentation access without requiring internet connectivity to the TurboPentest domain. ## Knowledge Base vs. Learning Center The documentation knowledge base and the CAPO Learning Center serve different purposes: - **Knowledge Base (docs)** - Reference material for looking up specific features, API endpoints, and configuration options. Designed for quick answers. - **Learning Center (learn)** - Structured courses with progressive learning, quizzes, flashcards, and certification exams. Designed for deep understanding. Both draw from the same underlying content, but the learning center adds pedagogical structure, assessments, and a certification path.