Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Improve API reference docs

オープン
  • 何か問題がありますか？
#2,667 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@szaganek がすでに取り組んでいます。

2026年6月22日 から。

評価

この issue はまだ評価されていません。

説明

documentation t-docs

The problem:

  • Only 29% of model properties (254/871) have a description.
  • 2xx success responses are mostly empty, only ~6% have any descriptive text;
  • request bodies almost never have a description (2 of 67).

TODO:

  • Complete missing field descriptions.
  • Review endpoint descriptions and links.
  • Update and improve existing content.
  • Look into section titles.
  • To consider: there's no separate topics/sections that describe objects.

Split work into sections (Actors, then Actor versions, then Actor builds...).

主要言語
JavaScript
スター
82
フォーク
240
平均マージ
4日 2時間
マージ済み PR（30日）
44

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apify/apify-docs のほかの issue

apify/apify-docs の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。