Contributing Advent 22: Documenting changes

Amsterdam, Netherlands

Sunday, December 22nd 2013, 09:10 CET

Probably one of the easier things to contribute to an Open Source project when you don't really have much experience, or simply don't know the language well enough—or in Xdebug's case, PHP's internals, is documentation. In the past a few people, such as Wim Godden and Jarl Ostensen have already contributed some documentation fixes.

Xdebug's documentation is part of the website, which has a project on GitHub. However, it's not in any standard format. Functions are documented in single files, such as here for xdebug_start_trace(), and in a rather rudimentary format that some other tools I have use to generate stuff as well. So a bit tricky, and this is something I'd like to improve, however it's rather easy to add to.