SMF Community Helpers > SMF Documentation Help

Developer documentation

<< < (2/5) > >>

live627:

--- 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.
--- End quote ---
How would you like to see it? This, because I don't have any ideas on a good front page.


--- Quote ---Thank you, live, for the initiative and time for it!
--- End quote ---
Sure. I do lack the time to do it properly sometimes, as may be evidenced from a fulll year of lack of contributions to the documentation.


--- Quote ---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.
--- End quote ---
YAY!! That's great news! But, it generates flat files, although, Smarty (yes, that is the templating system it uses to format its output)) can be modified to inject its values into the database to become new wiki pages (err, I assume MW uses MySQL or equivalent).

Arantor:

--- Quote ---YAY!! That's great news! But, it generates flat files, although, Smarty (yes, that is the templating system it uses to format its output)) can be modified to inject its values into the database to become new wiki pages (err, I assume MW uses MySQL or equivalent).
--- End quote ---

Yes, MW uses MySQL but it doesn't do what you might think it does - you need to have inputs in multiple tables to make it work.

Better would be to have it dump files and then write an import script, sort of like what I did with SimpleDesk's docs, only actually putting them in a DB rather than anything else.

Norv:
I'm not sure I'm following the latter. Why would you import them to the wiki? They're html pages, generated according to the template chosen (we will want a template fitting for this site though). Once uploaded to a section of this site, they can be browsed, read, consulted. They're function documentation, API documentation, which doesn't need to change other than by changes in the codebase, and regenerating it when necessary.

Am I misunderstanding something? (kinda late around here! :D)

AngelinaBelle:
live,

Anything you can do will be great.

The advantage of Main_Page is that it is organized the way WE want it, instead of automatically generated.
The difference is like that between a table of contents and an alphabetized index.

You provide guidelines, doc writers and helpers can help with the writing.

emanuele:
A bit related to the topic:
http://www.simplemachines.org/community/index.php?topic=483693.0

Navigation

[0] Message Index

[#] Next page

[*] Previous page

Go to full version