Principle:Promptfoo Promptfoo Documentation Site
| Knowledge Sources | |
|---|---|
| Domains | Documentation, Developer_Experience |
| Last Updated | 2026-02-14 07:45 GMT |
Overview
Principle governing the Docusaurus-based documentation site that provides user guides, API references, and red team plugin/strategy catalogs for promptfoo.
Description
Documentation Site defines how the promptfoo documentation is structured, built, and served. The site uses Docusaurus v3 with a hierarchical sidebar navigation, Algolia search integration, and auto-generated content from shared data catalogs (plugins, strategies). The JSON Schema for configuration validation is hosted as a static asset. The principle mandates that all documentation content is version-aware, properly categorized, and that red team plugin and strategy catalogs are maintained as typed TypeScript data structures that drive both documentation rendering and programmatic access.
Usage
Apply this principle when adding new documentation pages, modifying the navigation structure, or updating red team plugin/strategy reference data.
Theoretical Basis
The documentation architecture follows the Data-Driven Documentation Pattern:
- Typed data catalogs (plugins.ts, strategies.ts) serve as single sources of truth for reference content
- Docusaurus React components render the data dynamically, avoiding manual synchronization between code and docs
- JSON Schema generation from Zod types ensures config documentation stays in sync with validation logic
- Sidebar configuration provides explicit navigation hierarchy rather than filesystem-based auto-generation