When the phpBB Team met in Prague last month for a short productivity meeting we achieved many things. We fixed bugs, worked on our bamboo infrastructure, reduced the size of the extension validation queue and worked on a new phpBB/Symfony Authentication bridge however one of the most significant things we did was start the base of our new developer documentation:
The plan with this documentation is to consolidate all core and extension development related information that is currently spread out on our wiki, Area51 (and a variety of other places) into one central location.
As a first step the “[HowTo] Convert a 3.0 modification into a 3.1 extension” tutorial was converted and is now available to view here.
Since then, we have ported over many many other Wiki pages and readmes to the new doc system including:
- Language, translation and plurals: https://area51.phpbb.com/docs/dev/31x/language/index.html
- Migrations: https://area51.phpbb.com/docs/dev/31x/migrations/index.html
- Testing: https://area51.phpbb.com/docs/dev/31x/testing/index.html
- [Tutorial] How to write an extension: https://area51.phpbb.com/docs/dev/31x/extensions/tutorial_basics.html
The documentation is written using rst and our documentation source can be found in the “development” folder of our pre-existing documentation repository: https://github.com/phpbb/documentation/
We will be continuing to move existing documentation over the coming months and if you are familiar with rst and git(hub) and want to help, please do feel free to send pull requests. Whether it is with porting existing documentation over, fixing typos or even writing brand new pieces of documentation, every contribution is appreciated.