ember-learn / ember-learn/ember-cli-addon-docs
Sorting through APIs using visibility
- 主要言語
- JavaScript
- スター
- 172
- フォーク
- 142
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.

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.
コントリビューションガイド
調査の方向性
まず、docs サイトの現在の API レンダリングと、issue に示されている可視性 POC を確認します。提案された動作が、言及されている docs の再設計にどのように適合するかを確認します。完了条件は、public API が最初に表示され、private API と deprecated API が、初期表示を圧迫することなく、明示的なパスから利用できることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript
- 領域
- documentation, frontend
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100