Skip to content
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

Merged
merged 2 commits into from
Aug 29, 2024

Conversation

laminne
Copy link
Member

@laminne laminne commented Aug 26, 2024

概要

close #13

  • deno docを利用してドキュメントを生成するスクリプトの実装
  • 生成されたドキュメントの追加

@laminne laminne self-assigned this Aug 26, 2024
@laminne laminne enabled auto-merge August 26, 2024 11:39
Copy link
Contributor

@MikuroXina MikuroXina left a 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 ファイルをバージョン管理する方針なのでしょうか?

@laminne
Copy link
Member Author

laminne commented Aug 26, 2024

HTMLのドキュメントはデプロイする前提で考えています

@laminne
Copy link
Member Author

laminne commented Aug 26, 2024

これらのドキュメントをバージョン管理するのは意味がなさそうなので、CI等で自動生成してデプロイする感じにした方が良さそう

@laminne laminne disabled auto-merge August 26, 2024 12:14
Copy link
Contributor

@m1sk9 m1sk9 left a 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 などを使うべきです...

@laminne laminne force-pushed the feat/13-internal-spec-document branch from 5b25d9f to eee465b Compare August 26, 2024 12:16
@laminne laminne requested a review from m1sk9 August 29, 2024 09:48
Copy link
Contributor

@m1sk9 m1sk9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spec に残しておくことについてはもう少し話しておく必要がありそうですが, とりあえず Approve します

@m1sk9 m1sk9 merged commit e121e6b into main Aug 29, 2024
1 check passed
@m1sk9 m1sk9 deleted the feat/13-internal-spec-document branch August 29, 2024 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(docs): 内部仕様ドキュメントを自動生成して提供する
3 participants