Skip to content

docs: add README with installation and usage documentation#5

Merged
mariussm merged 2 commits into
mainfrom
copilot/add-readme-with-documentation
Mar 17, 2026
Merged

docs: add README with installation and usage documentation#5
mariussm merged 2 commits into
mainfrom
copilot/add-readme-with-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 17, 2026

README contained only the module title — no guidance on prerequisites, installation, or how to run the module.

Changes

  • Prerequisites — PowerShell 7.1+, Microsoft.Graph SDK install command, required Entra ID permissions (LifecycleWorkflows.Read.All / LifecycleWorkflows.ReadWrite.All)
  • Installation — PowerShell Gallery (Install-Module) and from-source (git clone + Import-Module) paths
  • Usage — step-by-step connect → run flow, plus a full end-to-end example:
Connect-MgGraph -Scopes 'LifecycleWorkflows.Read.All'
Invoke-LCWMermaidGenerator -ReportPath './LifecycleWorkflowsReport.md'
  • Parameter reference — table for -ReportPath (type, required, default, description)
  • Output description — explains console output and the generated Markdown report, including the color-coded Mermaid diagram node legend
Original prompt

This section details on the original issue you should resolve

<issue_title>Missing readme with documentation on how to run</issue_title>
<issue_description>Missing readme with documentation on how to run</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: mariussm <426202+mariussm@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing README with documentation on how to run docs: add README with installation and usage documentation Mar 17, 2026
Copilot AI requested a review from mariussm March 17, 2026 09:54
@mariussm mariussm marked this pull request as ready for review March 17, 2026 09:55
@mariussm mariussm merged commit 5659a5f into main Mar 17, 2026
3 checks passed
@mariussm mariussm deleted the copilot/add-readme-with-documentation branch March 17, 2026 09:55
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.

Missing readme with documentation on how to run

2 participants