🌟
【備忘録】Githubレポジトリを簡単に解析できる機能
他人の作成したレポジトリを解析する際にReadmeを読んでも内容が全く分からず、コードを解析しようにも複雑すぎて読む気が失せてしまう...といった経験がありましたので、それをどうにかできないかと考えておりましたが、先日知人よりGithubの便利な機能を教えてもらいましたので備忘録もかねて紹介いたします。
1. DeepWikiとは
Deepwikiは、GitHub上のプロジェクト情報を自動で整理してくれるAI Wikiです。コードやドキュメントの情報をまとめてくれるので必要な情報にすぐアクセスできます。これにより、構成はどうなっているかや何をしているかをコードを読めなくてもある程度理解することができます。
今回は参考例としてforgemanさんの作成されたMincraftレポジトリを活用させて頂いております。
2. Deepwikiにできること
1. 情報を簡単に整理してくれる
質問すると関連情報やドキュメントをすぐに提示してくれます。
2. 情報を整理してくれる
コンポーネントを自動で大別してくれて、かつそのコンポーネント同士の簡単なつながりを図示してくれます。
3. 使用方法
任意のGithubレポジトリのURLのドメイン名（github.com）をdeepwiki.comに書き直すだけで使用できます。
新人だけでなく、不慣れなプログラミング言語が使用されているコードの解析にも使えると思いますので、周りにも布教しようと思います。
Discussion