Documentation - VoxelJS

[z3t0]

@shama @deathcap

I went a head and created a wiki where we can start working and putting up more collective documentation. Its only a start and we can totally disregard it if you wish. Also, the domain name should probably be changed to something like voxeljs.io etc. or something but it costs to get a better domain name, also we should discuss what it should actually be called, 'voxelwiki' doesnt sound too nice. Once you have made accounts on the wiki I will bump you up to admins so you have unrestricted powers :smile:

[z3t0]

Anything wiki related should probably be posted here.

[z3t0]

Do we have any logos or something that I can put up for voxeljs?

[z3t0]

I could work on replicating the cube on http://voxeljs.com/

[z3t0]

It seems that in all the excitement I forgot to put a link... Haha this is embarrassing

http://voxelwiki.x10host.com/index.php/Main_Page

[z3t0]

I have been doing some research and I think that instead of a wiki approach maybe we should go for more of a documentation approach, this is what I mean http://docs.readthedocs.org/en/latest/getting_started.html

[z3t0]

We should probably move all the repositories to a place like https://github.com/voxel and maintain them there so we can keep track of all the "official" plugins that work and keep developing them.

Also this adds to creating a strong centralized community that is dedicated to working on the voxeljs project.

@maxogden Could you please invite me to that organization, thanks.

[z3t0]

Here's where I am working on the documentation, I think it seems a lot better than a wiki. http://voxeljs-documentation.readthedocs.org/en/latest/

The github repo is here. https://github.com/z3t0/voxel-docs Let me know if you want to contribute, I'll add you to the list. I plan on transferring ownership over to the VoxelJS organization once I'm in.

[z3t0]

I'm up to the point in the docs where I am going to write the getting started and have already referenced @shama 's youtube video, but am confused as to which direction I should take, that is stackgl or three.js. I plan on explaining both of them (once I know more about them @deathcap some conclusive info on that would be nice) and then choose one to stick with and continue for the development, I am guessing that's gonna be stackgl ?

[z3t0]

In the documentation should we use ';' or just leave them out? It may seem like an odd question but its better if we can decide on one way or the other and keep using that for the sake of conformity.

[max-mapper]

@z3t0 I use https://github.com/feross/standard in most projects now. Porting this repo to use it would take some work, and its not super high priority, but for now don't use semicolons

[z3t0]

@maxogden Awesome thanksf for the link. Since we are trying to get things together I think it would be a good idea to officially support that standard and work on implementing it in the background, what do you think?

Also could you please add me to the VoxelJS organization. Thanks

[z3t0]

Working on a section for Plugin Development, I created a page based mostly on the readme in https://github.com/deathcap/voxel-plugins but will also make some written/screencasts walkthroughs on creating simple plugins from scratch.

[z3t0]

In working on writing documentation I realized that one important way to lower the barrier to entry is to standardize things. So I was thinking we should make some sort of official decision on coffeescript vs javascript.

Personally I am on the fence for this and can sway either way, but if i had to choose I would say coffeescript simply because this is a group maintained project and so the runtime javascript that gets generated will follow the same design patterns.

On the other hand if we decide to go for javascript then we should use something like https://github.com/feross/standard, mentioned by @maxogden ,to keep things standardized and easy to maintain.

[z3t0]

Created template for making voxeljs plugins. https://github.com/z3t0/voxel-plugins-template