Arc Forumnew | comments | leaders | submitlogin
1 point by aw 4985 days ago | link | parent

There was a previous discussion that if Arc documentation was in Anarki, some people might like to work on it. The documentation is now ready to be worked on, if people still want to do that.

If you'd like to work on the documentation, make changes to the template files (or rewrite the code which generates the documentation, etc., whatever you want), commit your changes to Anarki, and the resulting output will be published at http://arcdoc.eval.to/

(Currently this is a manual process for me to do the publish step so the output won't appear right away. I will most likely implement an automatic process at the point that someone does start working on the documentation in Anarki; as a) I won't need to write an automatic process if it turns out that no one does want to work on the documentation; and b) actually having to publish manually will motivate me to implement the automatic process really quick :-)

Details are in the README: https://github.com/nex3/arc/raw/master/extras/arcfn-docs/REA...

A couple of notes:

- I'm happy to publish the documentation in the subdomain of eval.to, but we don't have to; if you have a better domain all you'd need to do is add a CNAME to your DNS for us to publish under your domain.

- I didn't know how to run Anarki from the documentation directory so the "generate.sh" that I checked in uses the hackinator; to use Anarki instead to generate the documentation just fix generate.sh to use Anarki.