📖 [Docs]: README pages now use the standard module landing-page format#638
Open
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Open
📖 [Docs]: README pages now use the standard module landing-page format#638Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 06:30
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes README.md into a lightweight landing page aligned with the Template-PSModule default, pushing detailed usage guidance into PowerShell help and the generated module documentation.
Changes:
- Replaces the long-form README with a concise module overview.
- Simplifies installation instructions and points users to
psmodule.iofor full documentation. - Adds a brief contributing section directing users to the issue tracker.
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:25
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:26
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:28
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:33
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:38
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
README.md:28
- The file ends with a blank line containing trailing whitespace, which can trigger markdown/style linters. Remove the trailing spaces (and optionally the extra blank line).
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:43
View session
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:46
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:48
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 6, 2026 08:50
View session
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
changed the title
Applies the content-preserving README default: keeps the highlights/use-cases, supported platforms, and a condensed authentication guide (interactive, PAT, GitHub Actions token, GitHub App, Azure Key Vault, GHES/GHEC host, automatic token renewal), instead of deleting them.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 9, 2026 04:15
View session
| ```powershell | ||
| Connect-GitHubAccount | ||
| ✓ Logged in as system! | ||
| Connect-GitHubAccount -Mode OAuth # OAuth app instead of the GitHub App |
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
The README is the published psmodule.io landing page and the only home for the getting-started and authentication guide (device flow, OAuth, PAT, GitHub App, Azure Key Vault, GHES/GHEC host, token renewal). Restores that content and adds a Documentation section pointing to the generated command reference and Get-Help.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 9, 2026 04:57
View session
Contributor
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
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
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.
Keeps the full README content — the README is the published psmodule.io/GitHub landing page and the only home for the getting-started and authentication guide (device flow, OAuth, PAT,
GH_TOKEN/GITHUB_TOKEN, GitHub App, Azure Key Vault, GHES/GHEC-Host, custom app, automatic token renewal), supported use-cases, platforms, and references.Change is additive: folds the old Command Exploration subsection into a Documentation section that also points to the generated command reference and
Get-Helpwith a real cmdlet.Follows the updated README default (PSModule/docs#61). The per-command reference is generated separately from comment-based help; narrative content stays in the README because that is where it publishes.