Skip to content

📖 docs: Translate component-guide.md to English #1

@njueeRay

Description

@njueeRay

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

  1. Create docs/component-guide.en.md (keep the Chinese version as-is)
  2. Translate all section headings, parameter descriptions, and usage notes
  3. Keep code blocks, URLs, and parameter names in English (they already are)
  4. 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

  • docs/component-guide.en.md created
  • All sections translated
  • Cross-links between CN and EN versions added

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions