Skip to content

Fix New-IdlePlan example in plan-export.md documentation#122

Closed
Copilot wants to merge 2 commits intowebsitefrom
copilot/sub-pr-121
Closed

Fix New-IdlePlan example in plan-export.md documentation#122
Copilot wants to merge 2 commits intowebsitefrom
copilot/sub-pr-121

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 28, 2026

Summary

Corrects the New-IdlePlan example in plan export documentation to match actual cmdlet signature.

Motivation

The example used invalid parameters (-IdentityId) and wrong file type (.json instead of .psd1), which would fail if executed.

Type of Change

  • Documentation update

Changes

  • Changed workflow file extension from .json to .psd1
  • Added New-IdleLifecycleRequest call to create required request object
  • Removed non-existent -IdentityId parameter
  • Updated to use correct -Request parameter

Before:

$plan = New-IdlePlan -WorkflowPath './workflows/joiner.json' -IdentityId 'jdoe'

After:

$request = New-IdleLifecycleRequest -LifecycleEvent 'Joiner' -IdentityKeys @{ EmployeeId = 'jdoe' }
$plan = New-IdlePlan -WorkflowPath './workflows/joiner.psd1' -Request $request

Testing

  • Manual testing

How to test & review

Verify the example matches the cmdlet signature in src/IdLE/Public/New-IdlePlan.ps1 and follows the pattern from docs/use/quickstart.md.

Checklist

  • Code follows STYLEGUIDE.md
  • Tests added or updated
  • Documentation updated
  • No UI/auth logic added to IdLE.Core
  • No breaking changes without discussion

Related Issues

Addresses feedback from PR #121 review comment.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
Copilot AI changed the title [WIP] WIP address feedback from PR #121 on DocuSaurus migration Fix New-IdlePlan example in plan-export.md documentation Jan 28, 2026
Copilot AI requested a review from blindzero January 28, 2026 21:26
@blindzero blindzero closed this Jan 30, 2026
@blindzero blindzero deleted the copilot/sub-pr-121 branch January 31, 2026 22:53
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.

2 participants