Ticket #12 (closed task: wontfix)

Opened 5 years ago

Last modified 4 years ago

add out-of-source documentation

Reported by: ChristianK Assigned to: ChristianK
Priority: major Milestone: 0.3 GUI - Physics - Refactor Release
Component: documentation Version:
Keywords: Cc:

Description

Things that everyone needs to know, like:

  • How does a typical main loop look?
  • What's the concept behind the scenegraph?
  • How do I use the gui?
  • list of FAQs
  • other component help

Change History

04/18/07 05:35:54 changed by ChristianK

  • type changed from defect to task.

06/23/07 04:53:48 changed by ChristianK

This is still very much not done. I fear people will have trouble using the scenegraph and the physics system with the current state of the documentation. However, I don't have the time to write much about it. I didn't even extend the stub in Documentation for weeks...

07/16/07 19:52:59 changed by clayasaurus

  • milestone changed from 0.2 to 0.3.

Moving this to v.3. SG and physics are very new... due to change... and I want to get v.2 out soon. The Dazel team figured it out too :)

09/06/07 19:48:41 changed by clayasaurus

This will probably keep getting bumped up to the next milestone with each release, ... as, until things are stabilized, too much external docs will just go out of date.

However, I'm thinking of scratching my tutorials and things and just making a big wikibook instead for the future: http://www.wikibooks.org/

09/08/07 11:45:09 changed by ChristianK

This is true. But if we want people to use Arc, we absolutely *need* good documentation. However, a few more examples and more extensive in source documentation probably would be a good start. Let's focus on that first.

I'll leave the ticket open as a constant reminder... ;)

05/13/08 13:48:40 changed by clayasaurus

  • status changed from new to closed.
  • resolution set to wontfix.

I'm only going to use example code to show people how stuff works, now. Don't have time to write extensive docs.