Repository navigation
📖 [Docs]: README pages now use the standard module landing-page format - #13
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README.md to remove PSModuleTemplate boilerplate and clearly communicate that the project is not yet in an end-user-ready state.
Changes:
- Replaced template installation/usage/documentation sections with an explicit “Status” placeholder note.
- Simplified the contributing guidance to match the repository’s current scaffold/placeholder state.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
This branch has not been deployed
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.
The
DiscordREADME now follows the standard PSModule landing-page format. As this module is still a placeholder (scaffold-only, no supported commands yet), the README clearly communicates its status and directs users to PowerShell help and generated documentation once implementation begins — instead of showing scaffold code as if it were working usage.Changed: README states placeholder status clearly
The README keeps a short overview, a
## Statusnote explaining the repository is a placeholder, and a## Documentationnote deferring command details to generated documentation. No invented commands or template tokens remain.Changed: Contributing section removed
The
## Contributingsection was removed to align with the new module-README standard. Contribution guidance is handled outside the published landing page.Technical Details
README.mdonly.PSModule/Template-PSModule.