Skip to content

docs: Update RAI Planner docs for Phase 1 preflight, phaseGates, and template-aware resume - #2888

Open
pratik wayase (PratikWayase) wants to merge 2 commits into
microsoft:mainfrom
PratikWayase:docs/rai-planner-phase1-updates-2865
Open

docs: Update RAI Planner docs for Phase 1 preflight, phaseGates, and template-aware resume#2888
pratik wayase (PratikWayase) wants to merge 2 commits into
microsoft:mainfrom
PratikWayase:docs/rai-planner-phase1-updates-2865

Conversation

@PratikWayase

Copy link
Copy Markdown
Contributor

Description

Updates the published RAI Planner documentation to align with the recent code changes in .github/agents/rai-planning/rai-planner.agent.md and .github/instructions/rai-planning/rai-identity.instructions.md (Commit f8764b1).

Specifically, this PR:

  • Adds the new preflight, noticeLog, and phaseGates fields to the state management table in agent-overview.md.
  • Updates the Session Resume protocol in agent-overview.md to include template revalidation, assessmentContentFile checks, and securityPlanRef path normalization.
  • Updates the Post-Summarization Recovery protocol in agent-overview.md from 6 steps to 7 steps, inserting the preflight validation contract.
  • Updates the "How It Works" sections for all three entry modes in entry-modes.md to show that pointers/output preferences are resolved first, followed by the shared Phase 1 preflight.
  • Adds the ordered 4-step Phase 1 preflight sequence and stable-ID/evidence-gap handling to phase-reference.md.
  • Updates ms.date frontmatter for all three modified files.

Related Issue(s)

Fixes #2865

Type of Change

Select all that apply:

Code & Documentation:

  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with hve-builder and addressed all actionable findings
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)
  • Copilot hook (.github/hooks/*/*.json)
  • Eval spec added/updated for changed AI artifacts (evals/)

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Testing

Ran local validation scripts to ensure compliance with repository standards:

  • npm run lint:md -> 0 errors
  • npm run docs:generate -> Unchanged: 251 files
  • npm run format:tables -> Formatted modified files successfully
  • npm run lint:md-links -> No new broken links introduced (pre-existing OWASP 404s noted in unrelated files)

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (if applicable)

AI Artifact Contributions

N/A

Required Local Checks

The following local-safe validation commands must pass before merging:

  • Local validation aggregate: npm run validate:local
  • Documentation validation (if docs changed): npm run validate:docs
  • 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
  • Any new dependencies have been reviewed for security issues
  • Security-related scripts follow the principle of least privilege

@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Sep 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.00%. Comparing base (3e29a0b) to head (8ef4863).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2888   +/-   ##
=======================================
  Coverage   83.00%   83.00%           
=======================================
  Files         185      185           
  Lines       34924    34924           
  Branches      228      228           
=======================================
  Hits        28989    28989           
  Misses       5861     5861           
  Partials       74       74           
Flag Coverage Δ
docusaurus 90.60% <ø> (ø)
pester 83.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 2 files 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 docs for Phase 1 preflight, phaseGates, and template-aware resume

3 participants