ember-learn / ember-learn/ember-cli-addon-docs
Auto-populate router entries and nav list
- 主要言語
- JavaScript
- スター
- 172
- フォーク
- 142
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
コントリビューションガイド
調査の方向性
docsRoute() のエントリポイントと viewer.nav template/component を特定し、requirejs.entries と addon の doc markdown ファイルが現在どのように公開されているかを調べます。routes と navigation sections/items を自動生成でき、custom routes と inline nav content を維持できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- handlebars, javascript
- 領域
- documentation, frontend
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100