wehub-resource-sync
0d3cb498a3
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
82 lines
2.0 KiB
Markdown
82 lines
2.0 KiB
Markdown
# Documentation Site
|
|
|
|
Docusaurus-based documentation at [promptfoo.dev](https://www.promptfoo.dev/).
|
|
|
|
**Key rules:**
|
|
|
|
- Don't start your own dev server for the site (ask user first)
|
|
- Don't edit `CHANGELOG.md` (auto-generated)
|
|
- **Commits:** Always use `docs(site):` scope for all site changes (docs, pages, components, plugins, styles)
|
|
|
|
## Key Principles
|
|
|
|
1. **Small edits** - Most updates should be 1-5 lines
|
|
2. **Search first** - Find existing docs before creating new ones
|
|
3. **Don't rewrite** - Improve incrementally
|
|
4. **Don't modify headings** - Often externally linked
|
|
5. **No fluff** - Avoid embellishment words like "sophisticated"
|
|
|
|
## Before Making Changes
|
|
|
|
```bash
|
|
# Search for existing docs
|
|
grep -r "topic" site/docs/
|
|
find site/docs -name "*keyword*"
|
|
```
|
|
|
|
## Terminology
|
|
|
|
- Use "eval" not "evaluation" in commands
|
|
- "Promptfoo" when referring to the company or product, "promptfoo" when referring to the CLI command or in code
|
|
|
|
## Front Matter (Required)
|
|
|
|
```markdown
|
|
---
|
|
title: Page Title (under 60 chars)
|
|
description: Summary (150-160 chars)
|
|
sidebar_position: 3
|
|
---
|
|
```
|
|
|
|
## Code Blocks
|
|
|
|
- Add `title="filename.yaml"` only for complete, runnable files
|
|
- No titles for code fragments
|
|
- Use `// highlight-next-line` for emphasis
|
|
- Never remove existing highlight directives
|
|
|
|
## Admonitions
|
|
|
|
```markdown
|
|
:::note
|
|
Content with empty lines around it.
|
|
:::
|
|
```
|
|
|
|
Types: `note`, `warning`, `danger`
|
|
|
|
## Development
|
|
|
|
```bash
|
|
cd site
|
|
npm run dev # localhost:3000
|
|
SKIP_OG_GENERATION=true npm run build # Faster builds
|
|
```
|
|
|
|
## Anti-Patterns
|
|
|
|
- Verbose, LLM-generated explanations
|
|
- Repetitive content across pages
|
|
- Generic examples
|
|
- Bullet overuse where prose is clearer
|
|
|
|
## Source Alignment
|
|
|
|
- Red team docs: read `site/docs/red-team/AGENTS.md`; keep behavior aligned with
|
|
`src/redteam/AGENTS.md`.
|
|
- Assertion docs: update `site/docs/configuration/expected-outputs/` and
|
|
`site/docs/tracing.md` when assertion behavior changes.
|
|
- Code scanning docs: keep `site/docs/code-scanning/` aligned with `src/codeScan/` and
|
|
`code-scan-action/README.md`.
|