As mentioned in a previous post, we are completely re-doing the way we handle documentation for the project. Whereas before, it was all built using NaturalDocs, I decided to split the documentation into two separate types of documentation: Guides and the API. I believe this allows us to give the best presentation to both types, which are used for very different purposes.

Guides

The new Guides are taking a much more relaxed, tutorial style documentation. The guides will always match up to the latest official release, though docs will grow and get updated as time goes on. Right now, we're a small team trying our best to put out an excellent product, and we know that documentation is a priority. That's one of the reasons I am scrapping the current version of the docs to go with what I feel will provide a better experience.

Currently, the Guides section is pretty empty, but we will make sure it grows as fast as possible, around our paying clients.

API Docs

The API docs will continue to be built using NaturalDocs, directly from the source files. I believe our current source documentation is in pretty good state, but I will need to do a quick run through of all of the source files to verify. The API docs are still to be started on, as the current docs do a pretty good job of covering most of the bases.

A Helping Hand

If you'd like to get involved with the Bonfire documentation project, you can fork the docs project at GitHub and help out. We do have pretty comprehensive guides on how you can help out, so please take the time to read those.

If you have any questions, you can stop by the forums and strike up a conversation!