dgeni-alive How do you use this?

dgeni-alive is a documentation generator and there are no... docs?

Why not use dgeni-alive to generate some?

The example

var docgen = require('../scr/docgen')(); // src is spelled wrong.
docgen.package().config(function(log) { // package should be Package
    log.level = 'info';
})
.src(/* what the heck goes here? */);
.dest(/* a directory pathI assume? */);
.generate() // generates the HTML output I suppose.
.then(function(/* any parameters here? */){
  console.log("I'm done!");
});

doesn't really explain anything.

Please, can you document dgeni-alive and how to use it by itself (no grunt).

May 15 '16 23:05 trusktr

By the way, AngularJS is a well-known and widely-adopted library, but dgeni-alive only has two stars. This is probably because people come check it out, then have no idea how to use it (integrate it into an existing project). Documentation may help you get more stars. Just some constructive criticism, nothing personal. Would love to see this tool documented and easy to start using.

For now, I'm using less Angular-specific tools (doxdox and dox-foundation) because they are much easier to start using.

May 15 '16 23:05 trusktr

Hi,

Thank you for the comment. As you see, this is the very first issue and I'd be highly appreciated for more detailed feedback on the project: what and how should be improved, added and so on; what information is missing; etc.

I can't improve anything without the pointed feedback or, better, PR's just because it implementation reflects my 'common sense' of the doing things.

Feel free to ask detailed questions and I'll add the answers to the docs :)

May 16 '16 08:05 wingedfox

+1 @trusktr

@wingedfox A good place to start would be to add documentation around what @trusktr commented on in the code snippet above. I'm in the same boat, I would really like to use this, but the documentation is really unclear. If I have time, I will dig further... but in the meantime addressing the original comments would help.