Proto-UI/Proto-UI

Write the first-prototype contributor guide

Closed

#235 opened on May 4, 2026

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (12 forks)auto 404
F5 - Largedocsgood first issuehelp wantedv0 launch

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (PR metrics pending)

Description

Campaign: v0-good-first-issues Seed id: first-prototype-guide

Summary

Write a practical guide that helps a new contributor add their first Proto UI prototype.

Scope

  • Start from the existing prototype docs and contributor docs.
  • Use a small existing prototype as the walkthrough example.
  • Include local commands for build, docs preview, and checks.

Acceptance criteria

  • The guide has a clear step-by-step path from package location to demo.
  • The guide includes a checklist before opening a PR.
  • The guide links to relevant contracts instead of duplicating them.

References

  • apps/www/src/content/docs/en/build/prototypes
  • apps/www/src/content/docs/en/build/contribute.md
  • packages/prototypes/base/README.md

Out of scope

  • A full API reference rewrite.
  • Adapter implementation details.

Maintainer notes

Category: docs Difficulty: small

Contributor guide

Research direction
Read the existing prototype docs in `apps/www/src/content/docs/en/build/prototypes` and the contributor guide in `apps/www/src/content/docs/en/build/contribute.md`. Use a small prototype from `packages/prototypes/base/README.md` as a walkthrough example. Include local commands for building, previewing docs, and running checks. Ensure a step by step path from package location to demo, a PR checklist, and links to relevant contracts.
Tech stack
typescriptreact
Domain
documentationfrontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90