DOC: Add scenario doc pages for all 7 undocumented scenarios#1558
Open
varunj-msft wants to merge 1 commit intomicrosoft:mainfrom
Open
DOC: Add scenario doc pages for all 7 undocumented scenarios#1558varunj-msft wants to merge 1 commit intomicrosoft:mainfrom
varunj-msft wants to merge 1 commit intomicrosoft:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
PR 1 of 3 for User Story 7933 - Migrate Cookbooks to Scenarios.
Creates a doc page for each of the 7 scenarios.
New pages:
2_content_harms — ContentHarms (7 harm categories)
3_psychosocial — Psychosocial (crisis escalation, therapist impersonation). Incorporates key concepts from cookbook 5: rubric design, MHFA/ALGEE methodology, conversation-level scoring via create_conversation_scorer.
4_cyber — Cyber (malware/exploitation)
5_jailbreak — Jailbreak (template-based prompt injection)
6_leakage — Leakage (IP/sensitive data). Incorporates key concepts from cookbook 3: copyright testing with FirstLetterConverter, PlagiarismScorer with LCS/Levenshtein/Jaccard metrics.
7_scam — Scam (phishing/fraud)
8_garak_encoding — GarakEncoding (17 encoding-based probes)
Each page follows the pattern from 1_configuring_scenarios.py: overview, strategy table, CLI usage, programmatic usage, result interpretation.
Also updates doc/myst.yml TOC with the 7 new entries.
Subsequent PRs will migrate remaining cookbook content (PR 2) and delete the cookbooks directory with cross-reference fixes (PR 3).
Tests and Documentation
This is a documentation-only PR. No source code or test changes.
All 7 notebooks were executed locally committed with outputs. Execution times ranged from 23s (Jailbreak) to ~2m (ContentHarms, Psychosocial). Ruff check passes on all files. All .py/.ipynb pairs round-trip correctly.