ちゃんとしたドキュメンテーションサイトを作る

kakkokari-gtyih commented 1 month ago

Githubを直接見に行かせるのをやめたい AiScript Playgroundと統合させたドキュメンテーションサイトを作れるとよさそう

ドキュメンテーションサイトとして別リポジトリにするか？
- サイトとしての柔軟性は上がるが、ドキュメンテーションの更新をAiScript本体と併せてできない
- ドキュメンテーションはここにおいておいて別リポジトリとして参照する手もあるけどややこしい（こっちにpushされるたびにdocsリポジトリ側のsubmoduleを更新する or サイトのビルドWebhookを走らせる必要がある）
↑もしくは、Vitepressをdocsフォルダ内にインストールするか？
- ドキュメンテーションが同時に更新できるが、サイト自体の機能更新等もこのリポジトリで行うことになり若干煩雑になるかもしれない
ドメインをどうするか？
- AiScriptがMisskeyの関連プロジェクトという位置づけならaiscript.misskey-hub.netとかでも良さそう（そのへんの位置づけを私はあんまり理解していない）
- デプロイしたらもらえるドメイン系はなんか嫌（個人の感想です）

syuilo commented 1 month ago

Misskeyの関連プロジェクトではないわね

kakkokari-gtyih commented 1 month ago

じゃあドメインを取る or github.io なり pages.dev なりの既定サブドメインを使うになるか・・・

FineArchs commented 1 month ago

こっちにpushされるたびにdocsリポジトリ側のsubmoduleを更新する or サイトのビルドWebhookを走らせる必要がある

これが自動化できるなら別リポジトリに分けたい気がします

じゃあドメインを取る or github.io なり pages.dev なりの既定サブドメインを使うになるか・・・

個人的には既定サブドメインで十分かなと思います（Playgroundは今までそうだったし） Cloudflare Pagesのことはよく知らないのですが、Github Pagesと比べてどちらが良いとかあります？

uzmoi commented 1 month ago

Cloudflare Pagesのことはよく知らないのですが、Github Pagesと比べてどちらが良いとかあります？

SSRが出来るのとレイテンシが小さいぐらいだと思うので、ドキュメント置くだけなら変わらないと思います。

個人的には aiscript-dev/aiscript-dev.github.io リポジトリを作ってそこで管理するのが一番シンプルで良いかなと思いました。

takejohn commented 1 day ago

mdBookだとコードブロックの実行とか設定できるのでいいかもしれないです

takejohn commented 1 day ago

サイトだけを別リポジトリにするとドキュメンテーションをpushするまでサイトがどのように見えるか確認できないから、ドキュメンテーションごと別リポジトリにするか、このリポジトリでサイトジェネレータをインストールしたいです

takejohn commented 9 hours ago

mdBookだとコードブロックの実行とか設定できるのでいいかもしれないです

https://takejohn.github.io/aiscript-docs/ 試しに作ってみました一部のコードブロックはボタンを押すと実行されるようになっています gettextを使って英語に対応していて、右上の地球アイコンから切り替えられます

syuilo commented 9 hours ago

しゅごい

FineArchs commented 8 hours ago

サイトだけを別リポジトリにするとドキュメンテーションをpushするまでサイトがどのように見えるか確認できないから、ドキュメンテーションごと別リポジトリにするか、このリポジトリでサイトジェネレータをインストールしたいです

~~サイトジェネレータを独立のnpmパッケージ化して、aiscriptとaiscript-dev.github.ioで共用するようなことは可能ですか？~~ いやCargoのパッケージ（？）使ってるから難しそうだな…

takejohn commented 8 hours ago

~サイトジェネレータを独立のnpmパッケージ化して、aiscriptとaiscript-dev.github.ioで共用するようなことは可能ですか？~ いやCargoのパッケージ（？）使ってるから難しそうだな…

NAPI-RSとか使えば作れないことはないかも

uzmoi commented 7 hours ago

それをわざわざ作ってメンテするくらいなら、aiscript-dev.github.ioなりのドキュメント用のリポジトリに全部持っていくほうが良いと思います。

FineArchs commented 7 hours ago

とりあえずドキュメンテーションごと別リポジトリ化するのが楽そうなのでまずそっちでやって、

~サイトジェネレータを独立のnpmパッケージ化して、aiscriptとaiscript-dev.github.ioで共用するようなことは可能ですか？~ いやCargoのパッケージ（？）使ってるから難しそうだな…

NAPI-RSとか使えば作れないことはないかも

これができそうなら後からでも欲しいかも。（これまでのコードの変更とドキュメントの変更を同じPRで要求できてた仕組みはかなりプラスに働いていたように思うので）

aiscript-dev / aiscript