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

Sorting through APIs using visibility

Ouverte
#121 7 commentaires 3 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
172
Forks
142
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner le rendu actuel de l’API sur le site de documentation ainsi que le POC de visibilité présenté dans l’issue. Confirmez comment le comportement proposé s’intègre dans la refonte de la documentation mentionnée. Le travail est considéré comme terminé lorsque les API publiques sont affichées en premier, tandis que les API privées et obsolètes sont accessibles via un chemin explicite sans surcharger la vue initiale.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation, frontend
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.