Skip to content

docs(agents): update RAI planner phase reference to consolidated rai-plan.md output - #2590

Open
Tas Devani (tasdevani21) wants to merge 4 commits into
microsoft:mainfrom
tasdevani21:docs/2569-rai-phase-reference-consolidated-output
Open

docs(agents): update RAI planner phase reference to consolidated rai-plan.md output#2590
Tas Devani (tasdevani21) wants to merge 4 commits into
microsoft:mainfrom
tasdevani21:docs/2569-rai-phase-reference-consolidated-output

Conversation

@tasdevani21

Copy link
Copy Markdown
Contributor

Pull Request

Description

Refresh docs/agents/rai-planning/phase-reference.md to reflect the phase-file consolidation completed in PR #2568, which merged the eight per-phase artifacts into a single rai-plan.md with named sections.

Changes across the whole file:

  • Phase Summary table: replace per-phase filenames in the "Key output" column with the corresponding rai-plan.md sections and subsections.
  • Phase 1-6 Outputs sections: point every bullet to a rai-plan.md section anchor while preserving the descriptive content.
  • Phase 2-6 Inputs sections: update references to prior-phase artifacts (for example, "System definition pack from Phase 1" → "rai-plan.md ## System Definition section from Phase 1") so the doc is internally consistent with the updated Outputs. This is slightly beyond the strict scope of the issue but leaving Inputs stale would contradict the Outputs on the same page.
  • Phase 5 footer prose: reference the Control Surface Catalog, Evidence Register, and Tradeoffs sections instead of the standalone artifact names.
  • Bump ms.date.

Verified against .github/agents/rai-planning/rai-planner.agent.md (Artifacts lines per phase) to make sure every section name and subsection matches the current output contract.

Related Issue(s)

Fixes #2569

Type of Change

Code & Documentation:

  • Documentation update

Testing

Verified section names against ground truth:

  • .github/agents/rai-planning/rai-planner.agent.md Artifacts lines for each phase (## System Definition, ## Stakeholder Impact, ### Risk Classification Screening, ## Standards Mapping, ## Threat Addendum, ## Control Surface Catalog, ## Evidence Register, ## Tradeoffs, ## Review Summary).
  • Grepped the file for the old standalone filenames and the pre-consolidation conceptual names to confirm none remain.

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)

Required Local Checks

  • Spell checking: npm run spell-check
  • Link validation: npm run lint:md-links

Security Considerations

  • This PR does not contain any sensitive or NDA information

…plan.md output

Refresh docs/agents/rai-planning/phase-reference.md to reflect the phase-file consolidation completed in PR microsoft#2568, which merged the eight per-phase artifacts into a single rai-plan.md with named sections.

- Phase Summary table: replace per-phase filenames with the corresponding rai-plan.md sections and subsections.

- Phase 1-6 Outputs sections: point to the corresponding rai-plan.md sections and preserve the descriptive content.

- Update the Phase 5 footer prose to reference sections instead of standalone artifacts.

- Bump ms.date.

Fixes microsoft#2569

📝
@tasdevani21
Tas Devani (tasdevani21) requested a review from a team as a code owner August 3, 2026 17:51
@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.10%. Comparing base (197afb8) to head (ff420e8).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2590      +/-   ##
==========================================
- Coverage   83.10%   83.10%   -0.01%     
==========================================
  Files         164      164              
  Lines       22254    22254              
  Branches       29       29              
==========================================
- Hits        18495    18494       -1     
- Misses       3756     3757       +1     
  Partials        3        3              
Flag Coverage Δ
docusaurus 95.07% <ø> (ø)
pester 86.48% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

docs: Update RAI Planner phase-reference doc to reflect consolidated rai-plan.md output

4 participants