ember-learn / ember-learn/ember-cli-addon-docs

New component with docs of a given component arguments

Abierto
#359 4 comentarios 1 reacción 0 asignados Ver en GitHub
Lenguaje dominante
JavaScript
Estrellas
172
Forks
142
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

So, this is a feature request of sorts. Hopefully I'm able to describe what I would like to have from addon-docs.

So, auto generation of api documentation using JSDoc or ESDoc is great. I think we could use that to generate documentation of all the arguments that a component can take.

The problem I see today with the API docs section, is that usually I will have a documentation page for a component with several live demos. Having the documentation of the arguments of these components in a separated page is not the best experience. I would expect a "table" with all the available arguments for that component, having: `type`, `description`, `default value` and etc.

A great example of this is what @pranavliag is doing with [ember-elements](https://dunkinbase.github.io/ember-elements/docs). Here is [one example](https://dunkinbase.github.io/ember-elements/docs/core/tooltip#props).

I would like to have a component from addon-docs that I can use in one of my custom pages that would include the table with the documentation of the arguments. I would just pass the component name to it and it would take care of rendering that list of arguments.

We should also be looking forward to support glimmer components `args`. It will be interesting if folks are using TypeScript to define their arguments interface, then we can probably extract that info somehow.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza revisando la sección existente de documentación de la API en addon-docs y el ejemplo enlazado de props de tooltip de ember-elements. Define cómo se asigna el nombre de un componente a sus metadatos de argumentos, incluidos el tipo, la descripción y el valor predeterminado, y ten en cuenta los Glimmer args y las interfaces de TypeScript propuestos. La tarea estará terminada cuando un componente de documentación reutilizable renderice esa tabla en una página de documentación personalizada.

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

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.