ngdoc -- heavy use of nunjucks->partials good? about dgeni-packages HOT 1 CLOSED

Hi @stu-salsbury

Thanks for this post! It is really great to see another perspective of using dgeni. I always envisaged dgeni being completely customisable and so it can certainly support the ideas you present here.

As you say at the bottom the protractor project already uses dgeni to generate its docs in a significantly different manner. Also, I believe, Ionic are using dgeni to create YAML files that are consumed by Jekyll to create the actual web pages.

Are you suggesting that we should change the dgeni packages that generate the core angular.js project documentation to follow this pattern or are you suggesting that this be for documenting angular apps in general?

In my mind I was conceiving of a generic "documenation" web application, to which we could upload multiple projects (or just versions of a single project) with enough metadata to allow the app to generate appropriate navigation. This shell application would be completely separate from dgeni and would specify an unambiguous definition of "documents" to be displayed.

So dgeni is just a document generation tool. It can be configured to produce just about any output you like from just about any input - hey you could even get your source by querying an SQL database if you wanted, or even write the generated documents into a CouchDB store. I guess what I would like to see is the community converging around a set of dgeni "Packages" that are useful to most situations.

I am trying to move the dgeni-packages Packages more toward more generic helpful processors that can be configured per project and don't force the developer to generate any one particular type of app.

from dgeni-packages.