DOC: Restructure documentation around three user pathways#1583
Merged
rlundeen2 merged 10 commits intomicrosoft:mainfrom Apr 10, 2026
Merged
DOC: Restructure documentation around three user pathways#1583rlundeen2 merged 10 commits intomicrosoft:mainfrom
rlundeen2 merged 10 commits intomicrosoft:mainfrom
Conversation
- Add transition sentence between Framework card grid and Architecture section - Fix broken front_end links in 0_scenarios -> point to scanner/ - Rename 1_red_team_agent -> 1_scenario_parameters, trim running/results sections (covered by scanner docs), keep datasets/strategies/scorers/baseline - Add baseline execution section to 0_scenarios overview - Update scanner breadcrumb in 0_scenarios How to Run section - Update all cross-references (myst.yml, scanner docs, foundry docs) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Psychosocial: conversation-level scoring, MHFA/ALGEE methodology, built-in rubrics (crisis_management.yaml, licensed_therapist.yaml), SubharmConfig customization, no-baseline rationale - Leakage: PlagiarismScorer metrics (LCS, Levenshtein, Jaccard), FirstLetter memorization detection, copyright testing methodology Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
# Conflicts: # doc/code/scenarios/1_scenario_parameters.ipynb # doc/code/scenarios/2_content_harms.ipynb # doc/code/scenarios/3_psychosocial.ipynb # doc/code/scenarios/5_jailbreak.ipynb # doc/code/scenarios/6_leakage.ipynb # doc/code/scenarios/7_scam.ipynb # doc/code/scenarios/9_baseline_only.ipynb # doc/scanner/foundry.ipynb # doc/scanner/garak.ipynb
- scoring/5_human_in_the_loop_scorer: ../gui/ -> ../../gui/ (.py + .ipynb) - converters/7_human_converter: ../gui/ -> ../../gui/ (.py + .ipynb) - setup/1_configuration: 9_baseline_only -> 1_scenario_parameters (.py + .ipynb) - contributing/README: architecture.md -> framework.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The 'files' field is a regex, not a glob. ^doc/* matches 'doc' + zero or more 'c' characters, not 'any file under doc/'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
romanlutz
approved these changes
Apr 9, 2026
ValbuenaVC
approved these changes
Apr 9, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
3 participants
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.
Reorganizes the doc site from a flat "User Guide" into three clear entry points for different user needs:
Key changes:
baseline_only) into 3 family-grouped scanner docs (AIRT, Foundry, Garak) — net -5,000 lines
baseline) rather than duplicating scanner usage