Skip to content

APIドキュメントにコード例を書く #563

@qryxip

Description

@qryxip

内容

各APIドキュメントに、次の形でコード例を書きます。

  1. 全体としての、クイックスタート
  2. 各APIの利用例

Pros 良くなる点

  • APIドキュメントとしてのわかりやすさが格段に増すことが期待できる

Cons 悪くなる点

  • 手間

実現方法

書く。

VOICEVOXのバージョン

N/A

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

  • Windows
  • macOS
  • Linux

その他

##532 でやるつもりでした。

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