Add documentation to HexDocs instead of readme

説明

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

技術スタック

elixirsvelte

領域

documentation

Issue 種別

documentation

難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。

2

推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。

1-3 hours

活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。

fresh

明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。

clear

前提条件

basic knowledge of ExDoc

初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。

80

調査方針

Review the existing README.md to identify comprehensive documentation that should be migrated to HexDocs. Then, create proper ExDoc module documentation in the source code (likely in lib/) and ensure that HexDocs is configured correctly (e.g., mix.exs). Finally, strip the README.md to only essential quickstart and reference information. Confirm the changes by building the documentation locally with `mix docs`.