evildmp / diataxis-documentation-framework

A systematic approach to creating better documentation.
https://diataxis.fr
Other
889 stars 166 forks source link

Add Aklivity Docs #102

Closed vordimous closed 11 months ago

vordimous commented 1 year ago

@evildmp anything else needed?

waldyrious commented 1 year ago

@vordimous maybe I'm missing something obvious, but could you point out how those docs are organized under the Diataxis framework? On a cursory glace I'm failing to identify that structure in how the docs are organized.

vordimous commented 1 year ago

@waldyrious of course! We organize all of our content using diataxis and present it to the user with a little more context. We do have a Reference section you can see then the first three links in the sidebar have the other elements that you can see in the URL path:

Because our project can do lots of different things, it is better to do some organization around function first and then use diataxis to make sure we cover each function. This is still somewhat WIP, but this section has all of the elements:

MQTT Proxy