woutdp/live_svelte

Add documentation to HexDocs instead of readme

Open

#35 建立於 2023年4月21日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Elixir (1,646 star) (73 fork)batch import
documentationgood first issue

描述

The documentation is getting a bit unwieldly, so let's move most things over to HexDocs and keep just the bare minimum in the README.md

貢獻者指南

技術棧
elixirsvelte
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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`.