Bullet wiki or documentation repo?

chunky
Posts: 146
Joined: Tue Oct 30, 2007 9:23 pm

Bullet wiki or documentation repo?

Post by chunky »

I've added some stuff to bulletthings.pdf again, and was just wondering if there's anywhere for users to add documentation for bullet yet?

Thanks,
Gary (-;
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

We could really use a Bullet Wiki, Documentation is far and away the biggest issue with Bullet at the moment.
sparkprime
Posts: 508
Joined: Fri May 30, 2008 2:51 am
Location: Ossining, New York
Contact:

Re: Bullet wiki or documentation repo?

Post by sparkprime »

Someone did a patch that added some more doxygen comments to the code but I don't think it got in. That kinda put me off doing something similar.

There is a wiki, I just made an account on it. Problem is it doesn't have much structure or content.

The ogre3d wiki is nice, that's what bullet needs I think. Lots of tutorials in increasing difficulty. Then some specialist tutorials for things like gimpact, concave decomposition, bsp or whatever. A page about the various broadphases and a page that goes into lots of detail about the collision shapes, with some kind of "feature grid" would be good too.

http://www.bulletphysics.com/mediawiki- ... =Main_Page
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

We've simply gotta improve the content on the Wiki, I'll start writing articles,

Would you be interested in helping? How bout Chunky?

We should decide on a structure for it, and what content we need to get in, then divide it up. Gotta prime the pump ;)
sparkprime
Posts: 508
Joined: Fri May 30, 2008 2:51 am
Location: Ossining, New York
Contact:

Re: Bullet wiki or documentation repo?

Post by sparkprime »

Two things come to mind - tutorials of various difficulty and articles about various specific things. However, I'm not sure I know enough about bullet to write such things. Maybe that's not the point - having anything at all is better and other people will fix it. Writing API docs is different as since I've read the code in question I *know* what it does :)
chunky
Posts: 146
Joined: Tue Oct 30, 2007 9:23 pm

Re: Bullet wiki or documentation repo?

Post by chunky »

Well, I originally wrote that with the intention of it going into a wiki...

Gary (-;
chunky
Posts: 146
Joined: Tue Oct 30, 2007 9:23 pm

Re: Bullet wiki or documentation repo?

Post by chunky »

As an aside, because I'd pasted code for my ogre3d motionstate so many times, and seen so many questions about motionstates, I updated bulletthings.pdf with a whole chapter on motionstates, with a specific example of one for Ogre3d.

Gary (-;
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

Chunky that PDF is single handedly the most important resource for Bullet, damn good job :)
chunky
Posts: 146
Joined: Tue Oct 30, 2007 9:23 pm

Re: Bullet wiki or documentation repo?

Post by chunky »

Well, I think it's safe to say that the pdf user guide in the bullet download package is still a better reference for bullet in general; I'm trying to just explain a few more specific issues in more detail

I just find myself adding to my own document anytime I find something that was hard for me to understand, or when I have a chunk o' code in my project that seems like it would be useful for other people

I'm honored that people find it useful, though. That delights me :-D

Gary (-;
sparkprime
Posts: 508
Joined: Fri May 30, 2008 2:51 am
Location: Ossining, New York
Contact:

Re: Bullet wiki or documentation repo?

Post by sparkprime »

I would like to contribute something right away but I'm writing my phd thesis and this is a bit too similar :)

Give it 6 long and unpleasant weeks
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

Ok I've been busy, but I still wanna improve the Wiki with anyone who is willing.

I would say the first problem is, right now, it's almost a meta-wiki. It's about things that are about Bullet. Not really about Bullet it's self.

The front page of the Wiki needs a new section:
- Bullet Users
With links like:
+ Start Here: Which describes how to get started
+ Chunkys Advanced Techniques Playground Extravaganza!: The Wiki form of chunkys PDF. Name is a WIP ;)

And so on. This front page block will provide the easy readily accessible gate way to the parts of the Wiki relevant to users.

What do you all think?
sparkprime
Posts: 508
Joined: Fri May 30, 2008 2:51 am
Location: Ossining, New York
Contact:

Re: Bullet wiki or documentation repo?

Post by sparkprime »

I suggest making all changes from

http://www.bulletphysics.com/mediawiki- ... umentation

at least for the time being since the front page isn't modifible. Later on it may be appropriate to create another frame on the front page for some hilighted content, but at the moment there isn't much content so that seems premature.

I say, completely rehash that page, dividing it up into at least tutorials, installation/compilation advice, and specific articles. There is some interesting stuff on there at the moment that can be moved into these categories. Then add more stuff into those categories, filling in any obvious gaps.

Your PDF could probably be divided into several articles as it is essentially a sequence of independent topics.
chunky
Posts: 146
Joined: Tue Oct 30, 2007 9:23 pm

Re: Bullet wiki or documentation repo?

Post by chunky »

Actually, none of it is modifiable at the moment. And yes, my pdf is meant to be bite-size chunks.

Gary (-;
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

delicious delicious bite size chunks.... mmm...

But you say the Wiki isn't editable? Well that sucks a bit :/
Wavesonics
Posts: 71
Joined: Thu May 22, 2008 8:03 pm

Re: Bullet wiki or documentation repo?

Post by Wavesonics »

Chunky I'm just curious here, but is there a specific reason you have your data members protected instead of private in your MotionState example?
Post Reply