Skip to content

Document extra_instructions and per-scenario config overrides#59

Merged
richardkiene merged 1 commit into
mainfrom
docs/customizable-prompts
Jan 23, 2026
Merged

Document extra_instructions and per-scenario config overrides#59
richardkiene merged 1 commit into
mainfrom
docs/customizable-prompts

Conversation

@richardkiene
Copy link
Copy Markdown
Contributor

Summary

Documents the features added in PR #53 (customizable prompts and per-scenario LLM config overrides).

Changes

Configuration Reference (docs/configuration/reference.md)

  • Add extra_instructions field to LLMConfig fields table
  • Add new "Extra Instructions" section explaining:
    • What extra_instructions does
    • Configuration priority (append behavior)
    • Examples for judge and synthetic_user

Scenario Format (docs/scenarios/format.md)

  • Add config to schema overview (now 6 top-level sections)
  • Add "Per-Scenario Configuration" section documenting:
    • ScenarioConfig fields (judge, synthetic_user)
    • ScenarioLLMOverride fields (model, temperature, extra_instructions)
    • Three practical examples
  • Update complete example to include config section

Test plan

  • Documentation renders correctly (markdown valid)
  • Examples are syntactically correct YAML
  • All documented features verified against code implementation

Adds documentation for features from PR #53:

- Add extra_instructions field to LLMConfig table in configuration reference
- Document extra_instructions usage with examples
- Add config section to scenario format schema
- Document ScenarioConfig and ScenarioLLMOverride fields
- Add per-scenario configuration examples
- Update complete example to include config section
@richardkiene richardkiene merged commit 742f169 into main Jan 23, 2026
3 checks passed
@richardkiene richardkiene deleted the docs/customizable-prompts branch January 23, 2026 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant