VitePressもしくはNuxtにする

syuilo commented 1 year ago

後継らしい

kakkokari-gtyih commented 12 months ago

VitePressに独自機能山盛りにするよりは、これを機に自由度の高いNuxtベース等で作ると、将来的に特設ページを作る際などに楽そう

一応、NuxtにもContent Moduleというマークダウンをよしなに処理してくれるモジュール（プラグイン）があるので、ドキュメントのメンテナンスという観点でもおそらく問題ないかと

（前勝手に作ったやつを参考程度に貼っておきます。こいつはNuxtです Related to #278 ） https://github.com/kakkokari-gtyih/about-misskey

syuilo commented 12 months ago

これをwipから完成状態にするにはどれくらいのパワーが必要そうかしら開発費の提供も可能

kakkokari-gtyih commented 12 months ago

@syuilo 費用というよりかは私のスケジュールの確保が難しそうなので何とも言えないですね・・・私ももちろん進められるようにはしますが、ほかの方に適宜コントリビュートしていただかないと時間かかりそうです

あと、API関連の情報に関してはmisskey-jsに依存させる構造にしてある（エンドポイント一覧についてもそうするのが楽そう？）ので、その部分に関しては、misskey-jsの整備が進まないと実装に入れなさそうかもしれません https://github.com/misskey-dev/misskey/pull/10752

それ以外で残っている作業として一番デカいのが既存のドキュメントの引っ越し作業になる（導線を改善するためにディレクトリ構造を変更している）のですが、それに関しては、ほかの方のご協力も仰いで進めることも簡単にできるのではないかと思います

残っている作業（参考）

[ ] ドキュメントの引っ越し作業
- [x] 最新情報への更新
- [ ] ローカライズドキュメントの移動
- [ ] ローカライズドキュメントのMarkdown内コンポーネントの記法変換
- [ ] API エンドポイント一覧のドキュメント作成
[x] ドキュメントページ
- [x] 左側ナビゲーションバー（Docsページ間ナビゲーション）の実装
[x] スマホ版UIの改善
- [x] ナビゲーションバーの実装
- [x] サーバー一覧ページの検索ボックス実装

syuilo commented 12 months ago

なるほどでもtailwind使ってることを考えると参考に留めて自分で1から作った方が今後を考えると良い可能性あるわね

kakkokari-gtyih commented 12 months ago

（あまりTailwindは好ましくないですかね・・・？）

syuilo commented 12 months ago

今からMisskey Hubのためだけにtailwind学習するのは難しいかも

kakkokari-gtyih commented 11 months ago

今からMisskey Hubのためだけにtailwind学習するのは難しいかも

24年4月以降は個人的に時間に余裕ができるので、それ以降なら私がサイトの面倒見れると思います（サイトのコンテンツ自体の更新はMarkdownベースなので、軽い修正ならしゅいろさんでもできるとおもうし、ほかのコントリビューターさんでTailwind等に詳しい人に助けてもらうこともできる）

kakkokari-gtyih commented 11 months ago

APIドキュメント以外はほぼできたとおもう

https://about-mk-kg.pages.dev/

kakkokari-gtyih commented 11 months ago

APIドキュメントも各エンドポイントのJSONを引っ張ってくるところまでは完了した

https://github.com/kakkokari-gtyih/about-misskey/tree/api-doc-gen

https://api-doc-gen.about-mk-kg.pages.dev/ja/docs/for-developers/api/endpoints/

syuilo commented 11 months ago

うおおおおおおしゅごい

kakkokari-gtyih commented 11 months ago

ただ、これはMisskey-jsではなく、Misskey本体のOpenAPI（っぽい）JSONを使ってやっていますいまは一旦「のえすきー」のOpenAPI仕様書JSONを取得するようにハードコーディングしてあります

API表示のコンポーネント作成で挫折したのでタスケテ…

kakkokari-gtyih commented 11 months ago

syuilo commented 10 months ago

もう https://github.com/kakkokari-gtyih/about-misskey をこのリポジトリにマージしたい

syuilo commented 10 months ago

というより別リポジトリにした方が良いかしら(そのままmisskey-devにtransferしてもらう)