Skip to content

docs: Revamp README for clarity, onboarding, and community growth#2

Merged
wspotter merged 2 commits intomainfrom
copilot/revise-readme-for-onboarding
Nov 30, 2025
Merged

docs: Revamp README for clarity, onboarding, and community growth#2
wspotter merged 2 commits intomainfrom
copilot/revise-readme-for-onboarding

Conversation

Copy link
Contributor

Copilot AI commented Nov 30, 2025

README had significant structural issues: duplicated Installation/License/Contributing sections, orphaned ASCII diagrams, Project Status buried at bottom, and no clear community engagement guidance.

Changes

Structure & Organization

  • Moved Project Status near top for visibility
  • Added "Spread the Word" block with social sharing links (Twitter, LinkedIn, Reddit)
  • Added "Getting Help / Contact" section with issue tracker pointers
  • Removed duplicate License (ISC), Contributing, Links, and Project Status sections from bottom

Installation

  • Consolidated duplicate installation sections into single unified section
  • Organized with collapsible tabs: Linux/macOS (open by default), Windows, Manual Setup

Contributing

  • Added prominent "🚨 We're actively looking for contributors!" banner
  • Direct links to good first issues and help wanted labels
  • Renamed "Areas We Need Help" to "🔥 Areas We Need Help" for visibility

Cleanup

  • Removed orphaned ASCII diagram fragment (lines 257-275)
  • Fixed broken emoji (�) in MCP Integration heading
  • Removed duplicate --- separators
  • Added TODO comment for screenshot placeholder
Original prompt

Revise the README to improve onboarding, reduce duplication, increase project discoverability, and promote community engagement, as follows:

  1. Add a prominent "Spread the Word" block near the top encouraging users to star and share the repo, with links for sharing.
  2. Move the "Project Status" section near the top after the project summary.
  3. Merge duplicated installation/setup instructions into a single, clear section with tabs or subsections for Linux/macOS, Windows, and Manual Setup.
  4. Remove duplicated License and Contributing sections from the bottom; ensure only one copy of each remains.
  5. Fix any incomplete badges or links in the intro.
  6. Standardize the use of "MCPower" throughout the document for consistency.
  7. Add a “Getting Help / Contact” section with pointers to issues and (if available) discussions.
  8. Replace the screenshot placeholder with an actual UI screenshot if available; leave as a TODO if not.
  9. Make the call to contribute and "help wanted" invitation more prominent in the Contributing section.
  10. Minor improvements to section ordering and clarity, but keep all existing technical info.

Provide a clear commit message, e.g. "docs: Revamp README for clarity, onboarding, and community growth".

This pull request was created as a result of the following prompt from Copilot chat.

Revise the README to improve onboarding, reduce duplication, increase project discoverability, and promote community engagement, as follows:

  1. Add a prominent "Spread the Word" block near the top encouraging users to star and share the repo, with links for sharing.
  2. Move the "Project Status" section near the top after the project summary.
  3. Merge duplicated installation/setup instructions into a single, clear section with tabs or subsections for Linux/macOS, Windows, and Manual Setup.
  4. Remove duplicated License and Contributing sections from the bottom; ensure only one copy of each remains.
  5. Fix any incomplete badges or links in the intro.
  6. Standardize the use of "MCPower" throughout the document for consistency.
  7. Add a “Getting Help / Contact” section with pointers to issues and (if available) discussions.
  8. Replace the screenshot placeholder with an actual UI screenshot if available; leave as a TODO if not.
  9. Make the call to contribute and "help wanted" invitation more prominent in the Contributing section.
  10. Minor improvements to section ordering and clarity, but keep all existing technical info.

Provide a clear commit message, e.g. "docs: Revamp README for clarity, onboarding, and community growth".


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: wspotter <125415284+wspotter@users.noreply.github.com>
Copilot AI changed the title [WIP] Revise README for improved onboarding and community engagement docs: Revamp README for clarity, onboarding, and community growth Nov 30, 2025
Copilot AI requested a review from wspotter November 30, 2025 16:11
@wspotter
Copy link
Owner

@copilot all done?

Copy link
Contributor Author

Copilot AI commented Nov 30, 2025

@copilot all done?

Yes, all changes are complete in commit c6b4b38. The README now includes:

  • "Spread the Word" block with social sharing links
  • "Project Status" moved near the top
  • Consolidated installation section with Linux/macOS, Windows, and Manual Setup tabs
  • Single License and Contributing sections (removed duplicates)
  • "Getting Help / Contact" section
  • More prominent "help wanted" call-to-action
  • Screenshot placeholder with TODO comment
  • Cleaned up orphaned content and fixed broken emoji

@wspotter wspotter marked this pull request as ready for review November 30, 2025 16:23
@wspotter wspotter merged commit 9177b1b into main Nov 30, 2025
1 check passed
@wspotter wspotter deleted the copilot/revise-readme-for-onboarding branch November 30, 2025 16:23
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.

2 participants