SMF Community Helpers > SMF Documentation Help

Developer documentation

(1/3) > >>

live627:
I find the developer docs for SMF seriously lacking. Now, this isn't a problem for me, as I can read the code and gather what I need too know from there. But I recognize that the vast majority of developers cannot do this, either as easily or not at all. S, they turn to documentation, which can attempt to explain the code in plain English, in varying degrees of success.

But, what if the desired document is non-existent?

A quirk snapshot:
[*] Function database: Mostly complete; still on the old site. Why hasn't it been moved? I'd assume its gargantuan size is the reason...
[*]Global variables: Not done by a long shot. I added a new section today, but I need more help. And here is the problem: most programmers do not want to document. However,, they be the perfect candidates for this task. Any volunteers? :D
[*] Package SDK: Needs work. Not done.
[*]Hooks: Mostly done.
[*]Coding guidelines: When did SMF become MVC--based??

Arantor:
Technically, SMF is sort of MVC based, but it's not how one might normally think of MVC, more a sort of hybrid model/controller with views methodology.

AngelinaBelle:
Live627 -- You have done a lot of doc writing in the past few days.

Thank you for the documentation you've just written.

I agree that documentation for developers is lacking.
And I really appreciate contributions from people who know this code inside and out.
I'm just a doc writer, myself :)
And the devs generally hate writing documentation.

It seems to me that the most important thing about this new content you are adding (other than getting the right information in there) is organizing it well. I can see you are using categories in your articles.  That will help.

I have not thouroughly read through your contributions. Do you have any questions about pulling this stuff together?  What do you think of a "developers  page" something like the main page at  http://wiki.simplemachines.org/smf/Main_Page

live627:

--- Quote ---And the devs generally hate writing documentation.
--- End quote ---
I can imagine. Moreso when they only finger type. Like me.


--- Quote ---Do you have any questions about pulling this stuff together? 
--- End quote ---
Not sure what you mean? Editing the wiki? Absolutely no problem. Finding older content around the forums and entering it into the wiki? "I assume that is what you mean.

The function database should be transferred to the wiki sometime soon, so everything's all in one place. Then whatever missing tidbits in it can be finished.
- For example, createList(). The only document on what it can work with is buried in a two year old thread started by me asking about it.
- There's more, but they escape my memory at the  moment


--- Quote ---What do you think of a "developers  page" something like the main page
--- End quote ---
I'm not sure, actually. It may be overkill. I'm content with the standard category page, really.

N. N.:

--- Quote from: AngelinaBelle on May 04, 2012, 11:09:27 AM ---What do you think of a "developers  page" something like the main page at  http://wiki.simplemachines.org/smf/Main_Page

--- End quote ---

Actually, I think it's better. We do have other pages to add, relevant pointers, and it would be best to do so. Some are discussed in another topic here, IIRC. Others are in preparation.

Thank you, live, for the initiative and time for it!

About function database transferring in the wiki: please note that SMF 2.1 and 3.0 (and up, of course), will have phpDoc-style documentation for the codebase. Which means it can be - and will be - automatically generated, and uploaded on the site. I don't really think another way to "transfer" is necessary (function database will remain available for legacy versions of SMF). Other than filling the useful information maybe, from function database, to SMF itself, to its phpDoc function documentation.

Navigation

[0] Message Index

[#] Next page