Ngx-admin: compodoc angular documentation

Created on 18 Oct 2017  路  4Comments  路  Source: akveo/ngx-admin

would you consider adding compodoc to generate documentation for angular modules, components, services,...etc?

this is a demo for the generated pages.

if yes, I can create a PR for that.

thanks

enhancement

Most helpful comment

So you mean like integrate the compodoc into ngx-admin so that people can generate docs for their projects later on? Well, this may be a good idea, let's keep it open to see if there any interest from the others.

All 4 comments

Hey @hatemhosny, thanks for the suggestion. We were reviewing compodoc sometime ago and decided to go a custom way for Nebular. For ngx-admin itself, I don't feel like we need this kind of documentation as we don't have much functionality here that could be documented inside of the code (because it's basically a template).

thanks for your answer, @nnixaa. I don't mean for ngx-admin itself. I think many will use ngx-admin as a starting point for their apps. This can be a helpful ready to use feature for their projects.

any way, thanks.

So you mean like integrate the compodoc into ngx-admin so that people can generate docs for their projects later on? Well, this may be a good idea, let's keep it open to see if there any interest from the others.

@hatemhosny , i think it's a good idea. This will be a great feature.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

hoswey picture hoswey  路  3Comments

nsankaranarayanan picture nsankaranarayanan  路  3Comments

mignam picture mignam  路  3Comments

igorls picture igorls  路  3Comments

argnist picture argnist  路  4Comments