Angular documentation

[Sean Nilan]

Hi, first off, I'd like to say I've really been enjoying AngularJS and hope to become an active member of the community.

I was wondering if it would be possible to open-source the AngularJS documentation on Github. This way, it would be easier to correct some mistakes and improve upon the documentation.

Thanks,

Sean

[Pawel Kozlowski]

Hi Sean,

On Fri, Feb 15, 2013 at 10:16 PM, Sean Nilan <sean....@gmail.com> wrote:
> I was wondering if it would be possible to open-source the AngularJS
> documentation on Github. This way, it would be easier to correct some
> mistakes and improve upon the documentation.

AngularJS documentation is open source and is on GitHub (in the main
AngularJS repo)!
It might be a bit confusing since docs are part of the code (comments
in code) and is generated automatically from the sources.
Just check individual files in the src folder and you will see what I mean.

Hope this helps,
PAwel


--
Looking for bootstrap-based widget library for AngularJS?
http://angular-ui.github.com/bootstrap/

[Peter Bacon Darwin]

Hi Sean 

Take a look at the comments in any of the files in src: https://github.com/angular/angular.js/tree/master/src.  This is the API docs.

Also there is most of the other stuff is in https://github.com/angular/angular.js/tree/master/docs/content

--
You received this message because you are subscribed to the Google Groups "AngularJS" group.
To unsubscribe from this group and stop receiving emails from it, send an email to angular+u...@googlegroups.com.
To post to this group, send email to ang...@googlegroups.com.
Visit this group at http://groups.google.com/group/angular?hl=en-US.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Sean Nilan]

Thanks for the quick replies! I should have looked further into the repo.

[Joel Davis]

Is the documentation on the AngularJS site up-to-date with the GitHub repo?  I'd love to have access to some more complete and better documentation, but I don't want to bother downloading and instalingl the GitHub version if it isn't any better.

[Josh David Miller]

Hello!

The documentation on the AngularJS website is up to date with the current release and will not be in sync with the GitHub repo. You can access the documentation for different releases from http://code.angularjs.org and you can build the documentation yourself should you want the latest from the master branch.

That said, what are you looking for in the GitHub version?

Josh

--

[Joel Davis]

I'm just looking for better/more complete documentation.  It seems like the best documentation on AngularJS tends to be scattered about as answers to questions here and StackOverflow.  I was hoping that since the documentation was open sourced, perhaps it has been getting updated and improved.  It would nice if it were easily available and editable so the community could improve it (perhaps a wiki?)

[Josh David Miller]

I agree the AngularJS documentation is not all that it can be - yet. The project is relatively young, so the wisdom is scattered across many sites. This will correct itself with time as more people contribute.

That said, AngularJS has a wiki for unofficial documentation on its GitHub page and there are already some interesting posts there; we should be creating more. But at the top of each official documentation page is a link to edit the docs, which opens in an editor at GitHub. So anyone is free to submit changes to the documentation should they feel a change, correction, or enhancement is warranted.