-
Notifications
You must be signed in to change notification settings - Fork 9
Open
0 / 10 of 1 issue completedLabels
enhancementNew feature or requestNew feature or request
Description
背景
READMEを見ても、何をどのような手順で行うかが分かりにくい。
一方でREADMEでは慣習的に、あまり細々と手順を書かない傾向がある。
たとえば「WindowsユーザならDockerを使うのかWSLを使うのかいくつかの選択肢があるよね」とか「Python環境を作る上でまずvenvとかで仮想環境を作るよね」のようなことはREADMEには書かないことが多い。これが原因で試してみようとした人がつまずく。
提案内容
docs/quickstart.mdを作り、頭から順に実行していけるようにする。細かい内容はdocs内に別ファイルとして作りリンクする。
その他
人間が書くと暗黙の前提を端折りがちだがAIに書かせると詳細に書いてくれるので良い。
Reactions are currently unavailable
Sub-issues
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request