Skip to content

📖 [Docs]: README pages now use the standard module landing-page format - #36

Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/fix-readme-placeholders
Open

📖 [Docs]: README pages now use the standard module landing-page format#36
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
mainfrom
docs/fix-readme-placeholders

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 5, 2026

Copy link
Copy Markdown
Member

The CurseForge README is a placeholder while the module is still scaffold-only. This change tidies that landing page by removing the boilerplate Contributing section, so the page only states what the module will be and its current status — no community boilerplate or scaffold examples shown as if the module were implemented.

Changed

  • Removed the ## Contributing section from README.md.
  • Keeps the placeholder shape: title, one-line description, ## Status, and ## Documentation.

Technical details

  • Updates README.md only.
  • No ## Usage added — the module exports no commands yet (scaffold-only), so there are no real examples to show.
  • Aligns with the standard module landing-page format from PSModule/Template-PSModule.

Copilot AI review requested due to automatic review settings July 5, 2026 23:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository README to remove PSModule template boilerplate and replace it with minimal, repository-specific information describing the project and its current maturity.

Changes:

  • Replaced template placeholders ({{ NAME }}, {{ DESCRIPTION }}) with a concrete module name and short description.
  • Removed scaffolded installation/usage/documentation sections and replaced them with a “Status” placeholder notice.
  • Simplified the “Contributing” section to a brief invitation for future contributions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: fix README placeholders Docs: standardize README Jul 6, 2026
Copilot AI review requested due to automatic review settings July 6, 2026 08:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Docs: standardize README 📖 [Docs]: README pages now use the standard module landing-page format Jul 6, 2026
Copilot AI review requested due to automatic review settings July 12, 2026 10:20

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) added the documentation Improvements or additions to documentation label Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants