FuelPHP Code Documentation

[WanWizard]

The application needs an interface through which the development documentation can be managed.

Current plan is to use:

• markdown for documentation text
• form-based entry for class and method documentation (forces a strict format)
• ? a special markdown command to insert a class::method docblock in the generated html
• version control on documentation
• moderation, with ability to delete or rollback versions
• release docs = a snapshot of all versions on a specific timestamp

Docs require user based access for modifcations, based on group membership with ACL's for 'no access', 'moderated access', or 'full access'.

A task should be written which will generate an HTML version of the docs, which can be used off-line, similar to the current documentation. It can also be zipped and presented for download on the main website.

[WanWizard]

For every change, the user who made the change must be registered. This will allow blame-like reporting later.

[ghost]

We also need a special markdown command for example code.

[ghost]

Version tags to permit searches, editing / updating and version specific html, pdf docs to be produced.

[WanWizard]

@Phil-F Example code works fine with the standard Markdown code block, in combination with the syntax highligher.

Or are you looking for something specific?

[WanWizard]

@Phil-F Documentation is organized per github branch. A search hasn't been implement it, but it would be logical to have 'version' as one of the selectable filters.

[monsonis]

@FrenkyNet @WanWizard, maybe it will be a good idea to internationalize the documentation in order to aid to translate fuelphp documentation to other languages. I´ve seen translations to japanesse and maybe i can help to translate to spanish.

[WanWizard]

I'm not in favour of that. unless we have someone that will maintain them, and is completely commited to maintaining it.

If not, we'll end up with an official documentation website with incomplete docs, which will then become our problem.