Documentation, documentation, documentation!

As with any open source framework, documentation unfortunately comes last (or doesn’t come at all)… Catel has a record of having great documentation, but we must admit we have become sloppy over the years. When we started the Catel journey, we were super motivated with both coding and keeping the docs up to date. Later on, the focus shifted towards code and the many other open source components we co-maintain. But we are getting more and more requests to update our documentation, and we can’t agree more this should get some more love. So without further ado, it’s time for change!

Time For A Change, New Ways, Letters, Words, Font

Automatic generation of the documentation site

Last week we’ve automated the process of generating the documentation automatically whenever a commit (or pull request) is done to the master branch. Before we had to regenerate the whole site locally and push it to GitHub pages. Thanks to GitHub actions, this is no longer required and the documentation will always be up-to-date with the latest content source.

Kinderen, Win, Succes, Video Game, Spelen, Gelukkig

Contribution guide

We know you are thrilled to be able to contribute to the Catel documentation. Therefore we’ve written an extensive guide on how to contribute to the documentation. You can find the guide in the root of the Catel.Docs repository. This means there are no more excuses left, go help us out if you are missing any docs, together we can make it better!

Duim, Hand, Arm, Begeleiden, Geleiden, Greep, Handgreep

We’ve also added contribution credits to each documentation site. If you contributed, you will show up at the bottom of each page:

image