Auto-generate JS doc

[aboodman]

In Go, we get Godoc for free. In JavaScript/Node I'm sure there are tools for this -- probably tons of them, all slightly broken and different.

[mikegray]

• godoc.org will automatically generate and host golang docs once our github repository is public. About Go Doc
• some info on godocs tricks
• in local repo, use godoc -http=:8080 then open http://localhost:8080/ to view

[arv]

I've had some minor success with https://github.com/documentationjs/documentation. The main downside is that it only generates API docs for things with JSDoc comments. That means that we have to manually add comments to every single exported function/class and every single method 😿

[arv]

Some status updates. I've landed some upstream changes at https://github.com/documentationjs/documentation. The big remaining task is to generate documentation for all exported functions/classes/vars.

[mikegray]

Once repo became public godoc works - https://godoc.org/github.com/attic-labs/noms. We still have work to do in order to make the content better - and of course we need a JS equivalent.

[aboodman]

I don't think we need a bug for "make content better" . That can just be
ongoing task. I'm going to retarget this bug to just JS.

On Wed, Aug 3, 2016 at 6:30 PM, Mike Gray [email protected] wrote:

Once repo became public godoc works -
https://godoc.org/github.com/attic-labs/noms. We still have work to do in
order to make the content better - and of course we need a JS equivalent.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#1471 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAE6BNPureLC1LDi_AHYfN34FIMqCNSXks5qcUDNgaJpZM4Ibff5
.

[arv]

Some update on the JS front. I've been contributing to documentation.js and there is one important feature missing. I have a PR for that: documentationjs/documentation#490. With that done we have "a complete" documentation.

We then need to setup a build that generates the HTML and deploy that somewhere.

After that I think we need to tweak the generated HTML quite a bit.

[arv]

The documentation.js tool is "good enough" to move on.

For deployment I could set up another ec2 instance or maybe we should just store these in s3 (since these are just static files).

@cmasone-attic @zcstarr @mikegray What do you think?

[mikegray]

Probably makes sense to take advantage of AWS CloudFront in front of S3 to serve these if they are all static.

[cmasone-attic]

agreed

[zcstarr]

agreed as well , I think @mike is right s3 + aws cloudfront for smooth sailing and low maintence

[arv]

We now automatically deploy to https://docs.noms.io/js/

I'm closing this. Lets open more specific bugs for things that needs to be improved.

[ghost]

So much awesome!