VOICEVOX / voicevox_core

無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXのコア
https://voicevox.hiroshiba.jp/
MIT License
857 stars 115 forks source link

ドキュメント:バージョン分けする #689

Open sevenc-nanashi opened 9 months ago

sevenc-nanashi commented 9 months ago

内容

今は開発中の最新版のみのドキュメントが用意されています。 が、たとえば0.14のCoreを使いたい人がドキュメントにたどり着いたら混乱してしまいます。 そのため、ドキュメントを https://flask.palletsprojects.com/en/3.0.x/ のようにバージョンごとに分けた方がいいと思いました。

Pros 良くなる点

Cons 悪くなる点

実現方法

バージョンごとに分けてドキュメント生成し、/apis/index.html にそれぞれのリンクを貼るのがとりあえず楽な気はします。

VOICEVOXのバージョン

...

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

その他

/apis/index.html をちゃんとした見た目にするのもやっていいかも。

Hiroshiba commented 9 months ago

issue作成ありがとうございます!

今は全てのドキュメントを全部生成していますが、過去のバージョンのドキュメントも毎回全部生成し直すのか、生成したものをずっと置いとくのかどうしますかね。 過去のバージョンのドキュメントも全部生成し直すのはきつい気がします。ドキュメントフレームワークを変更する時とかに過去のドキュメントが生成できなくなりそう。

github pagesの仕組みに乗っ取るのであれば、ビルド済みのhtmlをバージョンで区切ったディレクトリに配置して、そこは置き換えないようにする・・・? actions/deploy-pagesアクションにそういう仕組みがあると嬉しそう!(パッと調べた感じなさそう。。)

sevenc-nanashi commented 9 months ago

各リリースにdocuments.zipを添付する、と言うのもありな気がしました。