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

利用者向けのしっかりしたドキュメントやポータルを作る? #1001

Open
3 tasks
sevenc-nanashi opened this issue Feb 11, 2025 · 2 comments
Open
3 tasks

Comments

@sevenc-nanashi
Copy link
Member

sevenc-nanashi commented Feb 11, 2025

内容

コアを利用する開発者のための開発者向けドキュメントみたいなのがあると便利そうです。

Pros 良くなる点

  • 利用者に優しい

Cons 悪くなる点

  • メンテコストが増える

実現方法

ここら辺が候補になりそうかなと:

  • Vitepress:主にJS界隈で使われている印象。Vite、Shikiなど。
  • mdBook:主にRust界隈で使われてる印象。wasm-bindgenなど。

VOICEVOXのバージョン

0.17.0

OSの種類/ディストリ/バージョン

  • Windows
  • macOS
  • Linux

その他

関連しそう:

@sevenc-nanashi
Copy link
Member Author

sevenc-nanashi commented Feb 11, 2025

具体的にはこんな内容があると優しいと思います:

デプロイ場所はvoicevox_coreのGitHub Pagesあたりだと思います。
(エンジンのドキュメントも足すのもアリ?それならvoicevox/dev_portalみたいな感じのリポを作ってそこでやったほうがURLの見栄え的にも良ささう)

@sevenc-nanashi sevenc-nanashi changed the title 利用者向けのしっかりしたページを作る? 利用者向けのしっかりしたドキュメントやポータルを作る? Feb 11, 2025
@sevenc-nanashi
Copy link
Member Author

sevenc-nanashi commented Feb 11, 2025

これは完全に妄想も含まれますが:
ドキュメントサイト自体がレジストリになっていると楽しそうです。
具体的にはこう言うことをすると思います: https://github.com/sevenc-nanashi/vv_core_registry/blob/main/inject.ts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant