loopbackio / loopbackio/loopback-next
docs: move API references to tsdoc
Nadie ha tomado este issue todavía.
- 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:
-
The page "Model" contains reference-like content for model/property metadata mixed with guide-like content. We should rework the content into proper guides (recipes for achieving specific outcomes) and move reference description of different metadata options into tsdocs.
- https://loopback.io/doc/en/lb4/Model.html#supported-entries-of-model-definition
- https://loopback.io/doc/en/lb4/Model.html#unsupported-entries
- https://loopback.io/doc/en/lb4/Model.html#property-decorator
- https://loopback.io/doc/en/lb4/Model.html#id-properties
- https://loopback.io/doc/en/lb4/Model.html#data-mapping-properties
- https://loopback.io/doc/en/lb4/Model.html#supported-json-keywords
-
http://loopback.io/doc/en/lb4/Creating-crud-rest-apis.html#model-configuration-options
-
https://loopback.io/doc/en/lb4/Using-database-transactions.html#isolation-levels
-
The page "Interceptors" contains reference-like content with code snippets showing the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
-
The page "Life cycle" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
-
The pages grouped under Decorators are reference guides. Let's move their content into tsdocs and update "Decorators" page to act as a sign post linking to the API docs. For each page we have now, create a section in "Decorators" page and list the relevant decorators there.
-
The page "Context" contains reference-like content with code snippets the classes & interfaces including tsdoc. Let's find a better way how to present this information, leverage existing API doc pages and avoid duplication of content.
-
https://loopback.io/doc/en/lb4/Dependency-injection.html#additional-inject-or-sugar-decorators -- leverage the new "Decorators" page
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- 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