Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

compodoc angular documentation #1326

Closed
hatemhosny opened this issue Oct 18, 2017 · 4 comments
Closed

compodoc angular documentation #1326

hatemhosny opened this issue Oct 18, 2017 · 4 comments

Comments

@hatemhosny
Copy link
Contributor

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

@nnixaa
Copy link
Collaborator

nnixaa commented Oct 18, 2017

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).

@hatemhosny
Copy link
Contributor Author

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.

@nnixaa
Copy link
Collaborator

nnixaa commented Oct 18, 2017

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.

@tkmawarire
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants