Skip to content

[docs] Add dedicated contributor guide page to documentation site #7

@MarvyNwaokobia

Description

@MarvyNwaokobia

What needs to be done

Create src/content/docs/contributing.mdx — a contributor guide
embedded in the docs site itself (not just the CONTRIBUTING.md).

This page should be more welcoming and visual than a markdown file.
It is the first thing Wave contributors see when they browse the docs.

What to include

  1. Welcome section — who this project is for, what Wave is
  2. Contributor tracks — ZK/contracts, SDK/frontend, docs (with setup commands)
  3. How Wave works — points, cycles, earning rewards (link to drips docs)
  4. Your first contribution — step by step with GitHub flow
  5. Issue anatomy — how to read a wave_issue template
  6. Code standards — Rust clippy, TypeScript ESLint, Circom commenting
  7. Getting help — where to ask questions (GitHub discussions)

Definition of done

  • Page exists at /contributing in the docs site
  • Added to sidebar in astro.config.mjs
  • All setup commands verified to work
  • Links to org-wide Wave-ready issues

Estimated time

Half day

Required knowledge

Technical writing. No crypto knowledge needed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions