Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve API reference docs

Aperta
  • Qualcosa non va?
#2,667 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@szaganek ci sta già lavorando.

Dal 22/6/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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...).

Lingua principale
JavaScript
Stelle
82
Fork
240
Merge medio
4g 3h
PR unite (30g)
40

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apify/apify-docs

Tutte le issue di apify/apify-docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.