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

Auto-populate router entries and nav list

Abierto
#199 1 comentario 5 reacciones 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

Hey,

I've been using ember-cli-addon-docs for a project, it has been great for developing isolated components. Have found that there's a fair amount of boilerplate when adding something to the docs and thinking much of it can be automated.

Filtering the keys from requirejs.entries can yield all components/mixins/etc with addon doc md files, which can then be used to populate docsRoute entries in the router and build the navigation handlebars template for the docs viewer.

A method like autopopulateDocRoutes() would be nice to be able to add to a docsRoute() call to populate it with routes based on such auto-detection. For the template, a sub-component to viewer.nav like "nav.autopopulate" would also be fantastic to insert nav.section elements (for directories or types) and nav.item elements--inserted inline, rather than something replacing viewer.nav entirely, so it can appear alongside any other custom sections and items not represented by md files.

I built this functionality into a project to reduce trivial work and the number of merge conflicts when multiple team members are adding components to the docs, would love to see such a thing included by default.

Cheers

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Localiza el punto de entrada docsRoute() y la plantilla/componente viewer.nav; después, inspecciona cómo se exponen actualmente requirejs.entries y los archivos Markdown de documentación de los addons. Se considera completado cuando las rutas y las secciones/elementos de navegación puedan generarse automáticamente, conservando las rutas personalizadas y el contenido de navegación inline.

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

Evaluación

Stack tecnológico
handlebars, javascript
Área
documentation, frontend
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
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.