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

Sorting through APIs using visibility

Open
#121 7 comments 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
142
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.