Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Improve API reference docs

Abierto
#2,667 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@szaganek ya está trabajando en esto.

Desde el 22/6/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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

Lenguaje dominante
JavaScript
Estrellas
82
Forks
240
Merge medio
4 d 3 h
PR fusionados (30 d)
40

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apify/apify-docs

Todos los issues de apify/apify-docs

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.