Documentation sprint, 2013-01-19, in #minetest-doc

For people working on the C++ code.
Post Reply
User avatar
MarkTraceur
Member
Posts: 103
Joined: Sat Dec 03, 2011 05:41
Location: San Francisco, CA
Contact:

Documentation sprint, 2013-01-19, in #minetest-doc

by MarkTraceur » Post

Minetest core is a volunteer effort, but the barrier to entry is too high. In a series of changes meant to lower that, we're going to hold an event meant to help people understand the engine: A documentation sprint!

What: Documentation sprint for Minetest
Where: #minetest-doc on Freenode and http://dev.minetest.net
When: 2013-01-19 16:00 UTC to 2013-01-20 01:00 UTC

Come in to the channel, chat about the game, read some code, and write (or edit!) helpful documentation. Not a coder? That's fine, too! Document things about the community, how to create texture packs, or even how to write and edit documentation (meta-meta-documentation is probably not necessary).

We hope to achieve a more complete guide to contributing to the game engine, as well as being part of the community. We may not finish it that day, but it will sure be a great start!

Postscript: We could also meet up in real life in the Bay Area, if anyone is interested.
Last edited by MarkTraceur on Mon Jan 07, 2013 02:32, edited 1 time in total.
Mods: https://gitorious.org/marktraceur-minetest-mods
IRC: marktraceur on freenode

User avatar
rubenwardy
Moderator
Posts: 6275
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
Location: United Kingdom
Contact:

by rubenwardy » Post

I have started writing a manual, it is available on github: https://github.com/rubenwardy/minetest-manual
and on my website: http://multa.bugs3.com/minetest/manual/

Anybody is welcome to add to it, it is meant to be a joint community effort.

User avatar
Traxie21
Member
Posts: 753
Joined: Mon Dec 31, 2012 10:48
Location: McKinney, Texas U.S.A.
Contact:

by Traxie21 » Post

WOOT!
I'll probably miss this, but I cant wait to see what comes out of it.
Good luck all you who can articulate well!

User avatar
jojoa1997
Member
Posts: 2890
Joined: Thu Dec 13, 2012 05:11
Location: Earth

by jojoa1997 » Post

Will anyone be adding more to the dev wiki soon
Coding;
1X coding
3X debugging
12X tweaking to be just right

User avatar
dannydark
Member
Posts: 428
Joined: Fri Aug 12, 2011 21:28
Location: Manchester, UK

by dannydark » Post

+1 This is a great idea, I've got a few contracts that need finishing this weekend but hopefully I will be able to get a few hours out to give a hand in this.

EDIT: I've just seen that Celeron55 has announced this on his blog which is cool, maybe Thexyz or Celeron55 could also add a notice to the header of the forum (where the current message is about the forum being hosted elsewhere) that could help getting this thread some more traffic, as its kind of hidden away here hehe ^_^.
Last edited by dannydark on Wed Jan 16, 2013 19:06, edited 1 time in total.

User avatar
0gb.us
Member
Posts: 841
Joined: Sun Sep 16, 2012 01:55
Location: 0gb.us:30000
Contact:

by 0gb.us » Post

Wow, that will be great!

I'd love to help, but everything I know, I learned from the documentation, so all I know is ALREADY documented.

User avatar
PilzAdam
Member
Posts: 4026
Joined: Fri Jul 20, 2012 16:19
GitHub: PilzAdam
IRC: PilzAdam
Location: Germany

by PilzAdam » Post

0gb.us wrote:Wow, that will be great!

I'd love to help, but everything I know, I learned from the documentation, so all I know is ALREADY documented.
You can still move things from lua-api.txt to the dev wiki.

4aiman
Member
Posts: 1208
Joined: Mon Jul 30, 2012 05:47

by 4aiman » Post

It would be very nice to have compilation-under-windows article there.
As well as cross-compilation from Linux to windows.

User avatar
PilzAdam
Member
Posts: 4026
Joined: Fri Jul 20, 2012 16:19
GitHub: PilzAdam
IRC: PilzAdam
Location: Germany

by PilzAdam » Post

It would be nice if someone would make a summary of what was done.

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest