-
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: 内部仕様のドキュメントを自動生成できるようにした #14
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
これらの HTML ファイルはプレーンテキストをそのまま読むには適さなそうですが, これらは main ブランチに載せるのではなく GitHub Pages にデプロイするのでしょうか? それともそのままこれらの HTML ファイルをバージョン管理する方針なのでしょうか?
HTMLのドキュメントはデプロイする前提で考えています |
これらのドキュメントをバージョン管理するのは意味がなさそうなので、CI等で自動生成してデプロイする感じにした方が良さそう |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ちょっと待って. これらの大量の HTML をリポジトリに残すつもりですか?
流石に Git で管理する量ではないです. これらは本来人間が deno doc
など適切なコマンドを実行して生成してその場で確認すべきものであり, リポジトリに残すべきではないです.
プルリクエストのレビュー画面が固まって操作不能になるほどなのでもし公開したいのであれば Deno Deploy などを使うべきです...
5b25d9f
to
eee465b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spec に残しておくことについてはもう少し話しておく必要がありそうですが, とりあえず Approve します
概要
close #13
deno doc
を利用してドキュメントを生成するスクリプトの実装