Skip to content

refactor: redesign org profile README with concise product-catalog style#2

Open
pomelo-nwu wants to merge 1 commit into
mainfrom
refactor/profile-readme
Open

refactor: redesign org profile README with concise product-catalog style#2
pomelo-nwu wants to merge 1 commit into
mainfrom
refactor/profile-readme

Conversation

@pomelo-nwu
Copy link
Copy Markdown

Summary

Based on research of 7 major open-source org profiles (Microsoft, LangChain, Docker, Prisma, GitHub, Grafana, Vercel), redesign the org profile README to adopt a product-catalog style — concise, actionable, and scannable.

Closes #1

Changes

Structure overhaul

  • Lead with Quick Start — Banner, one-liner, badges, then immediately actionable install instructions
  • Fold Chinese into <details> — keeps above-the-fold clean while preserving all Chinese content
  • Remove marketing sections — industry workflow examples and "why choose us" table belong in docs, not the org portal
  • Consolidate ecosystem links — merged from two duplicate rows (EN + CN) into one at the top

Bug fixes

  • Fix orphaned </a> closing tag in footer
  • Clean up bare & in 3 Alibaba Cloud URLs
  • Complete the English Contributing section (was only 1 bullet)
  • Move DingTalk QR code from English section into the Chinese fold

Stats

  • 61 insertions, 113 deletions — ~46% reduction in total lines
  • All original information preserved (nothing deleted, only reorganized)

Research highlights

Org Style Takeaway
Microsoft Minimal enterprise Let products speak for themselves
LangChain Product catalog High info density, layered product list
Prisma Brand narrative <details> folding keeps above-fold clean
Grafana Minimal enterprise Full-width wallpaper + one paragraph + product list
Anthropic, OpenAI, HuggingFace No README Not applicable for growing orgs

Before / After

Before: Dual-language side-by-side, ~180 lines, marketing-heavy, footer HTML bug
After: English-first with Chinese fold, ~100 lines, product-focused, all bugs fixed

Signed-off-by: qwen-code

Based on research of 7 major open-source org profiles (Microsoft, LangChain,
Docker, Prisma, GitHub, Grafana, Vercel), adopt the product-catalog style
inspired by LangChain with Prisma's details folding technique.

Key changes:
- Lead with Quick Start so visitors can act within 10 seconds
- Fold Chinese content into details tag to keep above-the-fold clean
- Remove marketing sections (industry workflows, "why choose us")
- Consolidate duplicate ecosystem link rows into one
- Move DingTalk QR into the Chinese fold section
- Fix orphaned closing anchor tag in footer
- Clean up bare ampersand in 3 URLs
- Complete the English Contributing section

Closes #1

Signed-off-by: qwen-code
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.

重构 Org Profile README:基于知名开源组织调研的简洁化方案

1 participant