Page 1 of 1

Developer Documentation

Posted: 11 Aug 2011, 13:35
by Zini
Finally got around to finish up a few improvements to the developer documentation I had queued up.

Have a look at the Developer Reference page on the wiki: http://openmw.org/wiki/index.php?title= ... _Reference

I also made a new Contributions Wanted page (probably needs additional links for most of the check list items).

Two more documentation related tasks:

* Doxygen Cleanup
* More Component Namespace Cleanup

These can wait until 0.13.0 though. The roadmap for 0.12.0 is full enough.

I think I screwed up the formatting of one wiki page: http://openmw.org/wiki/index.php?title= ... edlink%3D1
Could someone with more wiki-expertise have a look at it?

As usual clean up (spelling, formatting, more links) is welcome.

I still have to add the Configuration page (see http://openmw.org/wiki/index.php?title=Architecture), but I would like to wait until we are deeper in 0.12.0 (still some minor issues to clear).

Anyway, that should fix the most important holes in our developer documentation. I consider our primary documentation effort concluded for now.

Re: Developer Documentation

Posted: 11 Aug 2011, 14:07
by Rhys
Zini wrote: I think I screwed up the formatting of one wiki page: http://openmw.org/wiki/index.php?title= ... edlink%3D1
Could someone with more wiki-expertise have a look at it?
Ooops, sorry I must have not noticed that jumbled link in "policies and standards", I'm guessing on the old site that page was not actually existing. So the link in the cached wiki was pointing to where you can create the page. So wiki thought you wanted to create a page called "Other_Coding_Rules&action=edit&redlink=1"
Is this what you mean?

Instead try http://openmw.org/wiki/index.php?title= ... ding_Rules (I copied the thing over)


These other ones should probably be deleted
http://openmw.org/wiki/index.php?title= ... edlink%3D1
http://openmw.org/wiki/index.php?title= ... ding_rules (sorry this was me, used wrong case :oops: )

Re: Developer Documentation

Posted: 11 Aug 2011, 14:20
by Zini
Yeah, that was what I meant.

Re: Developer Documentation

Posted: 12 Aug 2011, 12:39
by Zini
btw. I agree that these two pages should be deleted. We usually don't delete outdated pages (instead we flag them as outdated/obsolete). But these pages here aren't outdated content, but a plain technical error. I am not sure how to delete a page on a wiki permanently though.

Re: Developer Documentation

Posted: 12 Aug 2011, 15:25
by safferli
Zini wrote:btw. I agree that these two pages should be deleted. We usually don't delete outdated pages (instead we flag them as outdated/obsolete). But these pages here aren't outdated content, but a plain technical error. I am not sure how to delete a page on a wiki permanently though.
If you have admin (or, more precisely, write/delete) rights, you can soft-delete wiki pages. There should be a "delete" tab on top, next to the "history" one on the default layout.

Re: Developer Documentation

Posted: 12 Aug 2011, 16:17
by Zini
Nope. None there.

Re: Developer Documentation

Posted: 12 Aug 2011, 18:09
by lgromanowski
Because of integration of phpbb users and wiki some things are messed up - I will fix it in few moments.

// EDIT: Fixed - Zini have administration rights set. Page "Other coding rules" was deleted.

Re: Developer Documentation

Posted: 12 Aug 2011, 20:01
by Zini
Thanks.