Skip to content

[help wanted] Documentation site — contributor onboarding guides #14

Description

@GoDiao

Background

We have a website/ directory but it is not yet contributor-friendly. New contributors do not have a clear path from "clone repo" to "land my first PR". Three guides would unlock a lot of contribution traffic.

Tasks

  • How to add a new Provider — step-by-step: where the preset lives, how the connectivity test works, how to wire a logo
  • How to add a new MCP server (after #MCP_MARKETPLACE_ISSUE lands) — one-PR walkthrough
  • Codebase tour — high-level map of desktop/, src/, sidecar/, runtime/, adapters/ with a diagram

Each guide should ship in both zh and en, live under website/ (and optionally cross-link from docs/CONTRIBUTING_*.md).

Files

  • website/
  • docs/CONTRIBUTING_zh.md, docs/CONTRIBUTING_en.md

Difficulty / Estimate

⭐⭐ — half a day per guide; can be split into multiple PRs.

Mentor

Maintainer will provide the architecture diagram source if requested.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentation / websitedifficulty:2Half a day - 1 dayhelp wantedExtra attention is neededmentor-availableA maintainer is available to mentor

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions