I observe that there are, in some cases, a lot of comments in Akelos source code. May these be cut and pasted into the Akelos Wiki?
Er.. don't now, but I already started doing this.
The texts in the API documentation are hard to read. That's why I already copy/pasted of few of them to wiki pages.
OK. I guess it's all right to continue until somebody says "No." My question to you, thijs, is "How are you going about it?" My reason for asking is that I think that our efforts should appear the same way to other users. What wiki entries have you created from the API documentation? Should we preface these with the files that they come from, so that we don't inadvertently repeat the other person's work? Should we create our wiki entry when we first begin our cut/paste/modify the documentation so that we don't both cover the same material?
What wiki entries have you created from the API documentation?
Just the two I linked to above. Mostly because I have to look them up regularly and the API docs (mostly because of phpDocumentor I guess) are just not that readable.
Should we preface these with the files that they come from, so that we don't inadvertently repeat the other person's work?
Good idea. I did it on the has_many en belongs_to entries.
Should we create our wiki entry when we first begin our cut/paste/modify the documentation so that we don't both cover the same material?
Also a good idea. The chance that somebody else is working on a same or similar entry is small I guess. But if I want to make an entry in the future I will first make an empty page to signal it.
I'm gonna copy complete blocks of information every now and then. Good candidates -for instance- would be: AkActiveRecord AkHasAndBelongsToMany etc.. And we could build on that to add entries on details, like the working of certain methods etc.
1 to 4 of 4