Wiki Requests

General discussion about LÖVE, Lua, game development, puns, and unicorns.
User avatar
tentus
Inner party member
Posts: 1060
Joined: Sun Oct 31, 2010 7:56 pm
Location: Appalachia
Contact:

Wiki Requests

Post 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.
Kurosuke needs beta testers
User avatar
Tesselode
Party member
Posts: 555
Joined: Fri Jul 23, 2010 7:55 pm

Re: Wiki Requests

Post 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.
User avatar
TechnoCat
Inner party member
Posts: 1611
Joined: Thu Jul 30, 2009 12:31 am
Location: Milwaukee, WI
Contact:

Re: Wiki Requests

Post by TechnoCat »

Yeah, I feel the wiki is a pretty good reference for the LOVE API as-is.
User avatar
bartbes
Sex machine
Posts: 4946
Joined: Fri Aug 29, 2008 10:35 am
Location: The Netherlands
Contact:

Re: Wiki Requests

Post 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.
User avatar
zohnny
Prole
Posts: 7
Joined: Mon Jul 25, 2011 9:53 pm

Re: Wiki Requests

Post 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.
User avatar
tentus
Inner party member
Posts: 1060
Joined: Sun Oct 31, 2010 7:56 pm
Location: Appalachia
Contact:

Re: Wiki Requests

Post 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.
Kurosuke needs beta testers
User avatar
TechnoCat
Inner party member
Posts: 1611
Joined: Thu Jul 30, 2009 12:31 am
Location: Milwaukee, WI
Contact:

Re: Wiki Requests

Post 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
User avatar
kraftman
Party member
Posts: 277
Joined: Sat May 14, 2011 10:18 am

Re: Wiki Requests

Post 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.
User avatar
TechnoCat
Inner party member
Posts: 1611
Joined: Thu Jul 30, 2009 12:31 am
Location: Milwaukee, WI
Contact:

Re: Wiki Requests

Post 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.
User avatar
tentus
Inner party member
Posts: 1060
Joined: Sun Oct 31, 2010 7:56 pm
Location: Appalachia
Contact:

Re: Wiki Requests

Post 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.
Kurosuke needs beta testers
Post Reply

Who is online

Users browsing this forum: Ahrefs [Bot] and 0 guests