aweary/react-copy-write

Create standalone documentation

Open

#44 opened on Jun 27, 2018

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

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

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React basicsMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing README and source code to understand the library's API. Set up Docusaurus as suggested. Create a documentation site with pages for installation, usage examples, tutorials, and API reference. Ensure the site is deployable to GitHub Pages or similar.