Skip to content

feat(doc): add "ng doc" command #361

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

Closed
wants to merge 1 commit into from
Closed

Conversation

shairez
Copy link
Contributor

@shairez shairez commented Mar 29, 2016

see #324

@Brocco
Copy link
Contributor

Brocco commented Mar 29, 2016

Interesting, I was thinking of having documentation show right in the console, hadn't considered launching a browser.

That being said, I like the simplicity of this.

@hansl
Copy link
Contributor

hansl commented Mar 29, 2016

@Brocco; the end goal is to also have a man page for documentation. As of right now, documentation for ng2 is still being built so launching a browser is the second best we can do :)

@filipesilva
Copy link
Contributor

The only thing to point out is that maybe these new files could be in TS, otherwise both the design and implementation lgtm.

@@ -0,0 +1,25 @@
/* jshint node: true */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make this a .ts file? We support TypeScript in angular-cli. After that you can remove the use strict below as all ts files are strict.

@Brocco
Copy link
Contributor

Brocco commented Mar 29, 2016

@hansl of course this makes an excellent solution until we can get in-console docs

@filipesilva I agree w/ the idea of making these .ts files for consistency

@@ -0,0 +1,12 @@
/* jshint node: true */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the command above, please make this a .ts file.

@hansl
Copy link
Contributor

hansl commented Mar 29, 2016

2 nits, but LGTM overall. Good work.

@shairez
Copy link
Contributor Author

shairez commented Mar 31, 2016

Thanks!
Changed it to .ts and removed the use strict and the hint line.

@hansl
Copy link
Contributor

hansl commented Mar 31, 2016

Good work Shai!

Not sure why Appveyor has started failing. 🤷 LGTM. Do you have permission to merge? If so, you want to git push upstream $(git symbolic-ref HEAD):master (assuming you have the angular-cli repo as upstream) in order to merge. We don't use the button.

If you don't have the proper permissions I can merge for you.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants