New Leaf Documentation 🍁

[mychidarko]

Over the next month or two, we're planning to rebuild our website with fresh content!

This refresh is supposed to address a couple of issues:

• Problems with current documentation
  • Difficulty navigating
  • Scattered content
  • Older features still present
• Keeping up with changes since 3.0
  • Deprecation of Skeleton
  • Possible merge of Leaf MVC and Leaf API
• Drive a new focus on the beginner experience

We will also be prioritizing the functional mode API, so you will see a lot more of:

app()->get(...);

app()->run();

Instead of:

$app = new Leaf\App();

$app->get(...);

$app->run();

Additionally, we will be explaining more concepts in depth, going into some details about implementation and other ways you can creatively use some Leaf features. We will also be focusing on supporting material for the documentation which includes images, videos and illustrations. We want to make the documentation the single source of truth, but have a ton of supporting material that builds on what is found in the new documentation.

The rundown

The new documentation won't spare any effort in breaking down complex architectural problems and existing PHP features. We will treat every concept as a new one and explain in that fashion.

• Accessible to people of all levels
• Explains both Leaf and PHP concepts as if everyone is a beginner
• Interactive examples via the sandbox
• Use of more illustrations, images and videos

When complete, this will completely replace our existing docs. We'll move the current documentation to our documentation archive so it will still be available. The new documentation will be available at beta.leafphp.dev throughout the development phase. This discussion will also remain open for your comments, you can always add a new comment for your ideas, issues you notice or just random discussions regarding the documentation.

What to expect

We are aiming to have the new documentation online in the next month or two, roughly by November 2024. We have already completed the design phase and have started building out some static pages. We will be sharing some early updated documentation pages with the community for feedback. We hope to have a continuous feedback loop with the community, so please don't hold back if you have any feedback for us.

Thanks,
The Leaf Team ❤️

[mychidarko]

We have published a skeleton of the new documentation for desktop. You can take a look at beta.leafphp.dev and leave your feedback here. It's far from ready, but this should give you an idea of where we are going with this