Skip to content

READMEのAPIのドキュメントは分かりやすい場所に置いてほしい #490

@sh1ma

Description

@sh1ma

内容

開発お疲れ様です!よくVOICEVOXの使われた動画を視聴しています👍

コアのAPIのドキュメントは分かりやすい箇所に置いてほしいです。
なぜなら、コアを利用したい多くのユーザはすぐに機能を使い始めたいと感じているからです。

現状、READMEのAPIのセクションのみで言及するにとどまっています。
記載の変更、追加を行うのであれば、例えば一番上であるh1直下に置くなどしても良いのではないかと思っています。

Pros 良くなる点

APIドキュメントをより簡単に発見できる

Cons 悪くなる点

特に思いつきません。

実現方法

内容のセクションで言及しましたが、一番上であるh1直下に置くのが良さそうです。

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions