"Edit on GitHub" links are appearing on websites. Having fragments of refdoc pages in a git repo is an interesting concept, which would solve license, moderation and export issues.
In the case of the Elastic page much of that content seems to be generated from the doc comments in the Ruby file which the web page is referencing. So the Elastic site doesn’t seem to have fragments of refdocs on Github, its the actual doc comments in source files that are inserted in the web pages. At least that’s what it looks like to me.
Yes, basically they're allowing editing autodoc over github. Since we're suspicious on our potential commenters, just thought we wouldn't want to give them access to the actual code repo ;)
But the Pike beginner’s tutorial on the new site (which I hope to finish in the next comming weeks) works pretty much like you suggest. Those pages are generated from a local checkout of the
https://github.com/pikelang/tutorial repository. If that repo is updated it’s just a matter of pulling in the local repo (which could be scheduled) and the updates will automatically be available on the Pike site.
Looks good.
But we could perhaps use Gists to create a library of examples of various stuff. That would kind of nice.
Sounds interesting, not sure how we could do that.
Real world example : had an XMLRPC server issue to diagnose this morning, couldn't figure how to make Protocols.XMLRPC.Call and Protocols.XMLRPC.Client play together from the module reference.
Once i'll figure out, i'd keep sample code at least for myself. I tried to set up a github repo for keeping traces for new or ambigous stuff i'm working on, but that's obviously not a good format for sharing sample code:
--
Bertrand LUPART
29, rue du Colisée - 75008 Paris
+33 1 72 71 71 84