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

Sorting through APIs using visibility

Abierto
#121 7 comentarios 3 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

I’ve been helping out on the docs website for `ember-animated` and we’ve ran into a use-case where we would like to enable the users to only see public APIs starting off and give them the opportunity to venture off into private / deprecated APIs later on when they really need to — in order to not overwhelm them starting off.

Here's what I cobbled up as a POC -- as you'll see it's heavily inspired by the Ember docs.

![docs-visibility](https://user-images.githubusercontent.com/3945623/37740701-127c30e0-2d35-11e8-8e66-a9adb823fe94.gif)

Sam mentioned a re-design of the docs website so I'll hold out on this, but I'd be happy to help it come to life when the time comes.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza revisando la representación actual de la API en el sitio web de documentación y el POC de visibilidad mostrado en el issue. Confirma cómo encaja el comportamiento propuesto en el rediseño de la documentación mencionado. Se considera completado cuando las APIs públicas se muestran primero, y las APIs privadas y obsoletas están disponibles mediante una ruta explícita sin sobrecargar la vista inicial.

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

Evaluación

Stack tecnológico
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
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.