loopbackio / loopbackio/loopback-next

docs: move API references to tsdoc

Abierto
#5,778 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Docs epic feature
Lenguaje dominante
TypeScript
Estrellas
5.1k
Forks
1.1k
Merge medio
2 d 21 h
PR fusionados (30 d)
27

Descripción

As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should move API reference material from markdown files in site/docs folder to tsdoc comments in the source code.

This story is a part of #5113 Documentation improvements 2020Q3.

Acceptance criteria

List of places to modify:

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza revisando las páginas indicadas en site/docs y el contexto relacionado de #5549 y #5718. Compara las secciones similares a referencias con la documentación de API existente, especialmente para Model, Interceptors, Life cycle, Context y Decorators. Se considera terminado cuando el material de referencia indicado está representado en tsdoc, se han tratado los fragmentos duplicados y la página Decorators enlaza con la documentación de API relevante.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.