PeachPie is now a mature project and so it was only about time for it to have a proper documentation as well. That is why we are happy to introduce docs.peachpie.io.
Intro
PeachPie was started over 2 years ago, even though its history goes all the way back to 2005, when the first-generation PHP compiler to .NET was conceived: Phalanger. Until now, we focused almost exclusively on the development of the compiler and runtime. The project was documented sparsely on the GitHub Wiki, but our main objective was to make sure PeachPie was as compatible with PHP as possible.
It’s been long overdue, however, to put some effort into the project’s documentation in order to enable developers to use PeachPie more easily. You can now find the documentation at https://docs.peachpie.io/.
Structure
Just a small disclaimer to start off with – the docs are still a work in progress, and you will find sections that are still left to finish. The documentation is structured into four main topics that each have several subcategories:
- API Reference: a specification of the various runtime APIs.
- .NET Reference: information on cross-language calls and declarations between PHP and C# (.NET).
- PHP Guide: the section describing how to get PHP code running on .NET.
- Scenarios: real-world use cases for PeachPie, ranging from low level operations to high level utilizations
On the Welcome page, which is the homepage of docs.peachpie.io, you will also find the Getting Started section, as well as the Project Roadmap and an About section just in case you want to find out more about PeachPie.
Hopefully you find the new docs helpful. If there is anything you’d like us to add or clarify, please let us know.