aweary/react-copy-write

Create standalone documentation

Open

#44 opened on Jun 27, 2018

View on GitHub
 (3 comments) (2 reactions) (0 assignees)JavaScript (54 forks)batch import
help wanted

Repository metrics

Stars
 (1,791 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The current README isn't great. I'd love to have an actual website for documentation with examples, tutorials, API reference, etc.

I'm leaning towards using https://docusaurus.io/. It looks easy to setup, and it's a Facebook product so dog-fooding is a plus.

Contributor guide

Research direction
Set up a Docusaurus site for react copy write and write initial documentation including examples, tutorials, and API reference.
Tech stack
javascriptreact
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70