Open tarepan opened 3 months ago
qryxip
commented
3 months ago project-vvm-async-api が resolve してから充分な時間が経ち CORE 0.15.x の利用も進んでいる。
今のCORE 0.15はEDITOR/ENGINEのソング対応のために急遽0.14に手を加えたものであり、ユーザーからするとパブリックAPIは0.14と一切変わりません。project-vvm-async-apiはCORE 0.16となる予定です。 (このことに関して多分ドキュメントにもリリースノートにも残っていませんし、混乱されたユーザーの方も実際にいらっしゃるようです)
元々 #542 のちょっと後くらい(去年の夏)にリリースという感じだったのですが、CORE 0.16を出せるのは少なくとも今年の5月以降になりそうです。下手すると来年に突入しそうな気もします。それまでは工事中案内を出し続ける他ないかと思います。
qryxip
commented
3 months ago あ、工事中案内を0.14から0.15にするのはやった方がいいですね。
tarepan
commented
3 months ago 今のCORE 0.15はEDITOR/ENGINEのソング対応のために急遽0.14に手を加えたもの
なーるほど。
「main と release-0.15 は分岐してしばらく経ち、かつそれぞれ更新されており、数週間前の 0.15.2 にも数ヶ月前のmain 更新は入っていない」という認識で合っているでしょうか？
工事中案内を0.14から0.15にするのはやった方がいい
（私の上の認識が合っている前提で）
「ドキュメントは 0.14/0.15 API たる release 向けであるため、main での API 変更を反映する改修はまだ入れられない。ゆえに工事中案内は外せない。0.15 release 向けではあるので 0.14 → 0.15 の記述変更は必要。」で認識合っているでしょうか？
qryxip
commented
3 months ago 「
mainとrelease-0.15は分岐してしばらく経ち、かつそれぞれ更新されており、数週間前の0.15.2にも数ヶ月前のmain更新は入っていない」
ですね。ずれは数ヶ月というより一年くらいですが…
（私の上の認識が合っている前提で） 「ドキュメントは 0.14/0.15 API たる release 向けであるため、main での API 変更を反映する改修はまだ入れられない。ゆえに工事中案内は外せない。0.15 release 向けではあるので 0.14 → 0.15 の記述変更は必要。」
ドキュメントというよりは、現0.16が「プレビュー版」と銘打っているうちは全面に出さない方がよいというだけですね。
ドキュメント的にはむしろ既にhttps://voicevox.github.io/voicevox_core/apisが現行の0.16のものしか残っていなかったりしてて、それにより実際に混乱するユーザーがいらっしゃいますね… mainブランチ上のドキュメントは既に0.14の影は消えてますし。そう考えると0.15 (旧0.14)と0.16-preview (旧0.15)を併記して案内してもいいような気がしてきました。3月4月にリリースするどころか最悪冬にもつれ込みそうですし。
tarepan
commented
3 months ago 現0.16が「プレビュー版」と銘打っているうちは全面に出さない方がよい
...
既にhttps://voicevox.github.io/voicevox_core/apisが現行の0.16のものしか残っていなかったりしてて、それにより実際に混乱
ドキュメントごとに対応バージョンが異なり混乱源となっている、ということですね。
パッと見た感じ、以下のドキュメントが存在しています。
| 名称 | 実体 |
|---|---|
| README | README.md |
| VOICEVOX コア ユーザーガイド | docs/usage.md |
| API ドキュメント | apis/c_api |
| APIs | apis |
そして CORE には以下のバージョンがあります：
main0.15.3上記の混乱の原因は「どのドキュメントがどのバージョン向けか明示的に設計されていない」だと考えます。
どのドキュメントがどのバージョンを反映するのが理想形でしょうか？
tarepan
commented
3 months ago ref: ドキュメントのバージョン分け提案 #689
qryxip
commented
3 months ago どのドキュメントがどのバージョンを反映するのが理想形でしょうか？
というところですかね。mainとpreview版を分ける利点はあまり無いように思えます。
Hiroshiba
commented
2 months ago たしかに結構もったいないことになっているなと感じてきました。 わからなくて脱落されてるユーザーさんは結構多いかも。
工事中での案内を0.14→0.15にするの賛成です。 あと事情を説明するissueかドキュメントがあると良いのかなと感じました！ （たぶん @tarepan さんの提案がそんな感じなのかなと思っています）
とりあえずコメントまで 🙇
内容
要望概要: 工事中の案内を削除する
現在の
README.mdは #542 で導入された工事中案内「現在の main ブランチは工事中なので正しく動かないことがあります。バージョン 0.14.4をご利用ください。」が冒頭に貼られている。project-vvm-async-api が resolve してから充分な時間が経ち CORE 0.15.x の利用も進んでいる。結果、現状は工事中というより利用中が適切な状況になっている。すなわち現状と案内が乖離し始めている。
またこの工事中案内があるかぎり一部ユーザーは 0.15.x への移行を避けてしまうため、実利用による現行バージョンのバグ表出が停滞している。すなわち工事中表示しているがゆえに工事中品質から抜けづらい構図となっている。
このような背景から、工事中案内の削除による解消を提案します。
Pros 良くなる点
Cons 悪くなる点
283 で指摘された「mainはまだ一部動かない」「examleが追従できてなかった」が残っていた場合、エンバグになる。
実現方法
README.md更新VOICEVOXのバージョン
0.15.2