Description
The docs/component-guide.md documents all dynamic widgets used in the GitHub Profile (capsule-render, typing-svg, github-readme-stats, etc.). Currently it's written entirely in Chinese.
An English translation would make OpenProfile more accessible to the international community.
What to do
- Create
docs/component-guide.en.md (keep the Chinese version as-is)
- Translate all section headings, parameter descriptions, and usage notes
- Keep code blocks, URLs, and parameter names in English (they already are)
- Add a language toggle note at the top of both files linking to each other
Helpful context
- The file is ~310 lines of Markdown with tables and code blocks
- No coding knowledge required — this is a documentation task
- See the live profile for visual reference of each component
Acceptance criteria
Description
The
docs/component-guide.mddocuments all dynamic widgets used in the GitHub Profile (capsule-render, typing-svg, github-readme-stats, etc.). Currently it's written entirely in Chinese.An English translation would make OpenProfile more accessible to the international community.
What to do
docs/component-guide.en.md(keep the Chinese version as-is)Helpful context
Acceptance criteria
docs/component-guide.en.mdcreated