Skip to content

docs: refresh README and visual media kit - #18

Draft
paladini wants to merge 1 commit into
mainfrom
codex/improve-readme-visuals
Draft

docs: refresh README and visual media kit#18
paladini wants to merge 1 commit into
mainfrom
codex/improve-readme-visuals

Conversation

@paladini

Copy link
Copy Markdown
Owner

Summary

  • redesign the README header with a focused hero, useful badges, navigation, and a clearer opening narrative
  • add dedicated SVG artwork for the README, social previews, product explanations, and promotional campaigns
  • document dimensions and recommended usage in a reusable media kit
  • add automated checks for local image references, intended SVG dimensions, and accessible metadata
  • update the changelog

Why

The previous README header duplicated the project name, used too much empty space, and relied on artwork containing volatile project statistics. The result did not communicate the product clearly or present mcp-me like a mature open-source repository.

Impact

The repository now explains the product within the first viewport and provides maintainers and contributors with consistent, repository-owned promotional assets. The existing Open Graph image is also refreshed without changing runtime behavior.

Validation

  • npm run lint
  • npm run typecheck
  • npm test - 2,224 tests passed
  • npm run build
  • rendered and visually inspected all four SVGs at their native dimensions
  • verified the new website and badge URLs return HTTP 200

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.

1 participant