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

VitePressもしくはNuxtにする #292

Open
Tracked by #6
syuilo opened this issue Sep 5, 2023 · 22 comments
Open
Tracked by #6

VitePressもしくはNuxtにする #292

syuilo opened this issue Sep 5, 2023 · 22 comments

Comments

@syuilo
Copy link
Member

syuilo commented Sep 5, 2023

後継らしい

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Sep 7, 2023

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

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

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

@syuilo
Copy link
Member Author

syuilo commented Sep 7, 2023

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

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Sep 7, 2023

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

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

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


残っている作業(参考)

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

@syuilo syuilo changed the title VitePressにする VitePressもしくはNuxtにする Sep 8, 2023
@syuilo
Copy link
Member Author

syuilo commented Sep 8, 2023

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

@kakkokari-gtyih
Copy link
Contributor

(あまりTailwindは好ましくないですかね・・・?)

@syuilo
Copy link
Member Author

syuilo commented Sep 8, 2023

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

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Sep 23, 2023

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

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

@kakkokari-gtyih
Copy link
Contributor

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

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

@kakkokari-gtyih
Copy link
Contributor

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
Copy link
Member Author

syuilo commented Oct 3, 2023

うおおおおおおしゅごい

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Oct 3, 2023

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

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

@kakkokari-gtyih
Copy link
Contributor

image

@syuilo
Copy link
Member Author

syuilo commented Oct 29, 2023

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

@syuilo
Copy link
Member Author

syuilo commented Oct 29, 2023

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

@kakkokari-gtyih
Copy link
Contributor

抜本的にディレクトリを見直したせいでリンク切れが頻発しているのと、ローカライズ版の引っ越しがめんどくさすぎる問題がある…

@kakkokari-gtyih
Copy link
Contributor

ローカライズ版の引っ越しをどうすればいいか悩む(おそらくマンパワーが一番はやい)

@syuilo
Copy link
Member Author

syuilo commented Nov 3, 2023

今後Crowdinで管理したいから別に引っ越す必要はなさそう

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Nov 3, 2023

今後Crowdinで管理したいから別に引っ越す必要はなさそう

about-misskeyはDocsも含め全面Crowdin管理仕様にしてあるのですが、それでもやはり既存のドキュメントは移したほうが翻訳作業がだいぶ楽になる気がするんですよね

@syuilo
Copy link
Member Author

syuilo commented Nov 3, 2023

Crowdinって既存のドキュメント取り込む機能なかった気がする

@kakkokari-gtyih
Copy link
Contributor

kakkokari-gtyih commented Nov 3, 2023

あるにはある
これはこれで面倒くさそう()

https://support.crowdin.com/uploading-translations/

@kakkokari-gtyih
Copy link
Contributor

とりあえずCrowdinと連携させて(外国語ファイルは除く)、マンパワーで移行やるのが楽なのかも(CrowdinはGUIなので非エンジニアでもできる)

@kakkokari-gtyih
Copy link
Contributor

で、APIエンドポイントはHQにやってもらっているのでとりあえず放置で大丈夫そう

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

No branches or pull requests

2 participants