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

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

Open
3 tasks done
sevenc-nanashi opened this issue Nov 23, 2023 · 2 comments
Open
3 tasks done

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

sevenc-nanashi opened this issue Nov 23, 2023 · 2 comments

Comments

@sevenc-nanashi
Copy link
Member

sevenc-nanashi commented Nov 23, 2023

内容

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

Pros 良くなる点

  • 混乱が減る

Cons 悪くなる点

  • ないはず?

実現方法

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

VOICEVOXのバージョン

...

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

  • Windows
  • macOS
  • Linux

その他

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

@Hiroshiba
Copy link
Member

Hiroshiba commented Nov 23, 2023

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

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

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

@sevenc-nanashi
Copy link
Member Author

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

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

2 participants