Luvit Documentation

[Rob Searles]

Hi All,

Over the Christmas break I have finally had time to play around with Luvit, so far really enjoying working with it and learning Lua. As such, I have also started to do some documentation (see issue 16 - https://github.com/luvit/luvit/issues/16).

I'm using LDoc and you can see my progress so far here:

http://www.robsearles.com/luvit/

and my fork/branch is here:

https://github.com/robsearles/luvit/tree/docs/

I haven't created a pull request yet as only really tackled 4 modules (buffer, child process, query string and url) plus experimenting with linking to examples etc. 

Documentation for the documentation can be found here:

https://github.com/robsearles/luvit/blob/docs/docs.markdown

It would be great to get some feedback to see if I am on the right track.

Many thanks in advance

Rob

[Tim Caswell]

Thanks a lot for helping with this.  Sorry I've been to super busy lately.

Interesting, it seems ldoc assume lua style modules.  I see it's prefixing the modules with "luvit." as if they were part of the "luvit" module.

Also "API.markdown" and "errors.markdown" need to just be deleted from the repo.  They were notes to myself while implementing the initial luvit version about a year ago.

[Rob Searles]

Hi Tim,

I think the "luvit." prefix is because the files are in a directory called "luvit". I'll look into the config file to see if I can remove this at all.

Haven't done too much more since my original post as I've been hit with a torrent of work since coming back from Christmas break. Will try to get back on it asap.

Cheers

Rob

[Tim Caswell]

I understand busy, that's why I don't have docs yet.  You've done more than me.