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

Auto-populate router entries and nav list

Open
#199 1 comment 5 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
172
Forks
142
PR merge metrics
No merged PRs in 30d

Description

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

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.