Page 1 of 5

Wiki Requests

Posted: Fri Jul 29, 2011 2:15 pm
by tentus
So, the wiki is useful, but it's not complete. I was helping a friend learn Love and he kept coming back to me with "well, I checked the wiki, but what is / how does..."

To help, I think it might be a good idea for the community to posit areas in which the wiki could be improved. What is it missing? What needs more examples? Is there anything we can do to make the search feature work better? That kind of thing.

So please, spout off what you think needs improvement. Hopefully just talking about it here will help get some of the most common problems worked on, and everyone will be better off for it.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 2:56 pm
by Tesselode
I think people need to post their games and libraries on the wiki more often. Some of them never end up there. I can't really think of anything to improve the wiki itself, though.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 2:57 pm
by TechnoCat
Yeah, I feel the wiki is a pretty good reference for the LOVE API as-is.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 3:32 pm
by bartbes
That's the thing, it really is a reference manual at this point. Which I'm totally okay with. To new people, however, some documentation as to why you want to use something, and best practices for it might be good.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 3:57 pm
by zohnny
It is technically complete, but very confusing to newbies, such as myself. I feel that most pages could be improved with a more detailed description and some examples of games uploaded by users that shows how to use it.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 4:12 pm
by tentus
I don't feel like it's complete at all. Last weekend my friend asked me what dt was. I looked on the wiki and it didn't have a page, so I made one. Simple oversights like that can really trip up new people.

Did you guys know that we don't have an article on the .love file format, for example? I made one for zip several months ago, but I never got around to making one for .love.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 4:23 pm
by TechnoCat
tentus wrote:I don't feel like it's complete at all. Last weekend my friend asked me what dt was. I looked on the wiki and it didn't have a page, so I made one. Simple oversights like that can really trip up new people.

Did you guys know that we don't have an article on the .love file format, for example? I made one for zip several months ago, but I never got around to making one for .love.
I'm assuming you mean something beyond this: http://love2d.org/wiki/Game_Distribution

Re: Wiki Requests

Posted: Fri Jul 29, 2011 4:24 pm
by kraftman
The pages need to be a little more descriptive.

For example:

http://love2d.org/wiki/love.thread

"Allows you to work with threads" isn't very helpful for people don't know anything about threads. A quick blurb about why/how they are used would be great.

Similar thing for http://love2d.org/wiki/SpriteBatch.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 4:30 pm
by TechnoCat
kraftman wrote:The pages need to be a little more descriptive.

For example:

http://love2d.org/wiki/love.thread

"Allows you to work with threads" isn't very helpful for people don't know anything about threads. A quick blurb about why/how they are used would be great.

Similar thing for http://love2d.org/wiki/SpriteBatch.
Then they must be stupid! No, I'm just kidding. Good examples of things needing more elaborate explanations.

Re: Wiki Requests

Posted: Fri Jul 29, 2011 4:44 pm
by tentus
TechnoCat wrote:
tentus wrote:I don't feel like it's complete at all. Last weekend my friend asked me what dt was. I looked on the wiki and it didn't have a page, so I made one. Simple oversights like that can really trip up new people.

Did you guys know that we don't have an article on the .love file format, for example? I made one for zip several months ago, but I never got around to making one for .love.
I'm assuming you mean something beyond this: http://love2d.org/wiki/Game_Distribution
Search for ".love file" on the wiki. At the time of this writing, Game_Distribution is about the 35th result, putting it on the second page of Page text matches. :)

Also, notice that Game_Distribution starts by telling you how to make this file, before telling you why you should care about it. It's not a huge problem, but it does show who the writer(s) expected to read the article: people who are already using Love and want to know more, rather than people who are being introduced to Love and want to know what is what.