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

Auto-populate router entries and nav list

Aperta
#199 1 commento 5 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
172
Fork
142
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.