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

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

Open
kakkokari-gtyih opened this issue Oct 8, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kakkokari-gtyih
Copy link

kakkokari-gtyih commented Oct 8, 2024

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

検討すべき点

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

syuilo commented Oct 8, 2024

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

@kakkokari-gtyih
Copy link
Author

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

@FineArchs
Copy link
Member

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

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

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

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

@uzmoi
Copy link
Member

uzmoi commented Oct 12, 2024

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants