📖 [Docs]: Move documentation to MSX / Docs and reduce the README to a pointer#383
Merged
Merged
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 12, 2026 19:02
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR relocates the repository’s detailed documentation to the MSX / Docs site and simplifies this repository’s README to a short description plus a canonical documentation link.
Changes:
- Replaces the long-form README content with a concise overview of Process-PSModule.
- Adds a dedicated “Documentation” section that points readers to the MSX / Docs page.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| documentation, and publishes module to the PowerShell Gallery and its documentation site to GitHub Pages. It is the core workflow used across all | ||
| PowerShell modules in the [PSModule organization](https://github.com/PSModule), ensuring reliable, automated, and maintainable delivery of PowerShell | ||
| projects. | ||
| Process-PSModule is the corner-stone of the PSModule framework — an end-to-end GitHub Actions workflow that builds, tests, versions, documents, and publishes PowerShell modules to the PowerShell Gallery. |
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.
Moves the Process-PSModule documentation to the MSX / Docs site and reduces this repository's README to a short pointer.
The full documentation — getting started, pipeline stages, usage, configuration, repository structure, and principles — now lives at https://msxorg.github.io/docs/Frameworks/Process-PSModule/, added to MSX / Docs in MSXOrg/docs#39.
Changed: README
media/Process-PSModule.pngandmedia/pagesEnvironment.png) are removed; they were referenced only by the README and now live alongside the docs.Technical Details
NoRelease: the README is an important file, but this is a documentation-only relocation and should not cut a new version.DEPENDENCIES.md, the workflows, and all other files are unchanged; the docs link to them by absolute URL.