VOICEVOX / voicevox_core

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

feat(docs): docs/を整理する #863

Closed qryxip closed 3 weeks ago

qryxip commented 4 weeks ago

内容

docs/は今このようになっています。

docs
├── apis
│   ├── c_api
│   │   └── doxygen
│   │       ├── Doxyfile
│   │       └── doxygen-awesome-css
│   ├── index.html
│   └── python_api
│       ├── conf.py
│       └── index.rst
├── downloader.md
├── feature-options.md
├── usage.md
└── vvm.md

これを次のように再編します。

docs
├── ghpages
│   └── apis
│       ├── c_api
│       │   └── doxygen
│       │       ├── Doxyfile
│       │       └── doxygen-awesome-css
│       ├── index.html
│       └── python_api
│           ├── conf.py
│           └── index.rst
└── guide
    ├── dev
    │   └── vvm.md
    └── user
        ├── downloader.md
        ├── feature-options.md
        └── usage.md

image

アイデア元はRust Analyzerのdocs/です。

関連 Issue

その他

qryxip commented 3 weeks ago

ghpagesが一撃で伝わらなさそうであれば… そうだ、voicevox.github.io/voicevox_coreにするのはどうでしょうか? https://github.com/search?q=path%3Adocs%2F*.github.io%2F**&type=code

Hiroshiba commented 3 weeks ago

voicevox.github.io/voicevox_coreもちょっと伝わらなそうですが、まあ伝わらないということは伝わるので、良いかもですね!

README.md作って↓みたいに書くだけで全然十分そうな気はしてます。

* ghpages: Github Pagesを作るためのファイルいろいろ
* guide: 開発者向け・ユーザー向けのいろんなドキュメント

まあ書かなくてそのままマージで良いと思います!

qryxip commented 3 weeks ago

名前は"ghpages"のままにして、docs/ghpages/apis/下にREADME.mdを置いてみました。これどうでしょう? 5cc8c2e (#863)