I would like to start contributing to documentation and I'm looking for anything that explains what the best practices are for that. I'm currently working on FuelPHP 1.2.1 and due to the nature of the application it will always remain that version although I know that most of what I would contribute to 1.2 would also apply up to version 1.4 (current).
Some of my other general questions would be:
1. Are previous versions of the documentation available online? I know there is current master (1.3) and dev docs (1.4-dev) but what if someone had the same situation as myself and was left to need referencing 1.2 documentation?
2. Would I be making pull requests to every master and/or develop branch or just develop and then moderator would pull them to master?
The current documentation is written in html (hardcoded), and stored in a github repository. There is only one branch current, which is the develop branch. At the moment, that is 1.4/develop.
Bugfixes on the release version (1.3/master) will be documented in that version, and merged to 1.4/develop. All other documentation has to go in 1.4/develop, other versions are not maintained anymore. Assuming you have a local webserver (or run PHP 5.4 which has a built-in webserver) you can host the docs locally.
These two versions are online to, http://docs.fuelphp.com for master, http://dev-docs.fuelphp.com for develop.
This is quite a complex process, difficult to maintain, and difficult to contribute to. So we're working on an application that is easier to work with, and doesn't require repo's and hardcoded html. We've nicknamed it "Fuel Depot", but developing is running behind due to lack of time.
If you would like to contribute, it would be great if you could help finishing the application. It's in it's own repo on Github.
Donate
