aweary/react-copy-write

Create standalone documentation

Open

#44 opened on 2018年6月27日

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

説明

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.

コントリビューターガイド

技術スタック
javascriptreact
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
React basicsMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.