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

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

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

qryxip
Copy link
Member

@qryxip qryxip commented Oct 26, 2024

内容

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 qryxip requested a review from Hiroshiba October 26, 2024 12:25
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

ghpagesディレクトリが何なのかわかんなさそうなので、docs直下にREADME.md置いて説明を書いてもいいかもですね!

@qryxip
Copy link
Member Author

qryxip commented Oct 28, 2024

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

@Hiroshiba
Copy link
Member

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

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

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

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

@qryxip
Copy link
Member Author

qryxip commented Oct 29, 2024

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

Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

あ、docs/README.mdを考えてたりしました!!
でも今のプルリクエストの形でも全然良さそうに思います!!

@qryxip qryxip merged commit fdae73a into VOICEVOX:main Oct 29, 2024
29 checks passed
@qryxip qryxip deleted the feat-docs-organize-docs-dir branch October 29, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants