HeadlinesBriefing favicon HeadlinesBriefing.com

GitHub Wiki アンチパターン: Wiki ではなく /docs を使用

Hacker News •
×

「Wiki を使うべきか、GitHub で docs フォルダを使うべきか」という議論は数ヶ月ごとに再燃します。Shawn Wang の「スリーストライクルール」に従い、著者は GitHub で Wiki を使うことはアンチパターンだと主張します。Wiki の唯一の利点は常に利用可能なことですが、バージョニング、ローカルアクセス、ピアレビュー、ブランディングオプションが欠けています。一方、/docs フォルダはドキュメントをコードと統合し、バージョニングをサポートし、プルリクエストレビューを可能にし、Vale やスペルチェックなどのツールと連携します。Wiki はアップロードをサポートしないため、画像は別の場所にホストする必要があります。ドキュメントを公開するには、just-the-docs などのテーマとともに GitHub Pages と /docs フォルダを使用します。ドキュメントをコードと共にバージョン管理するために gh-pages ブランチは避けてください。プロジェクトが成長するにつれてドキュメントは別リポジトリに移行するかもしれませんが、コントリビューターはすでにワークフローに慣れています。著者は Twitter でのフィードバックを歓迎しています。