generator-angular icon indicating copy to clipboard operation
generator-angular copied to clipboard

feat(gen) add grunt-ngdoc to Gruntfile

Open marcin-wosinek opened this issue 10 years ago • 8 comments

Grunt part of the pull request #551

marcin-wosinek avatar May 11 '14 14:05 marcin-wosinek

How much test coverage should be have here?

marcin-wosinek avatar May 13 '14 15:05 marcin-wosinek

these two lines should be modified: https://github.com/marcin-wosinek/generator-angular/blob/ngdocs-grunt/templates/common/root/_Gruntfile.js#L77-L78

eddiemonge avatar May 13 '14 23:05 eddiemonge

In the lines you've mentioned I've added watching for changes in documentation.

marcin-wosinek avatar May 14 '14 07:05 marcin-wosinek

I meant this line will livereload and put files in .tmp: https://github.com/yeoman/generator-angular/pull/680/files#diff-c90fa6beac4c4a4ca179fcb210e6e096R43 which will then trigger the livereload on line https://github.com/yeoman/generator-angular/pull/680/files#diff-c90fa6beac4c4a4ca179fcb210e6e096R78 which can result in excessive livereloads. So if coffee dont listen for that second line anymore

eddiemonge avatar May 14 '14 17:05 eddiemonge

Ok, I got it now.

In neither cases we don't need to watch docs files. this will live reload docs for coffee; and this in case of js.

I've tests and in both cases doc page is automatically refreshed when doc is regenerated.

marcin-wosinek avatar May 14 '14 18:05 marcin-wosinek

No, not for the docs. Im talking about normal JS. When a .coffee file is edited, it does not trigger a live reload. CS writing the processed files to the .tmp folder trigger the live reload.

With your change, a live reload is also triggered when the docs are updated. Line 78 of your changes should be removed since line 46 will do the same.

eddiemonge avatar May 14 '14 18:05 eddiemonge

updated

marcin-wosinek avatar May 14 '14 19:05 marcin-wosinek

im not a fan of having the docs in the actual site

Ideally these should be available on a different "site". As in not part of the actual site the user is building since end users of the developers project don't/shouldn't need to see the docs for the code part.

eddiemonge avatar Jul 24 '15 18:07 eddiemonge