You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Opening discussion to see if there are ways to improve our CBL-Mariner documentation so the reader is naturally guided to information they seek
Describe the solution you'd like
Consider adopting a framework like https://diataxis.fr/
Diátaxis posits there are four modes of documentation, each serving a clear use-case along the 2 dimensions of "theory vs practical" and "study vs application"
Describe alternatives you've considered
AI
Additional context
Intent is not to switch all the docs over to this framework, but to consider using this framework when creating new docs and improving iteratively towards a clear guideline. Having a framework like this in mind helps guide the reader when they land on the docs page AND it helps doc authors with where to place new content and what to write there.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
Opening discussion to see if there are ways to improve our CBL-Mariner documentation so the reader is naturally guided to information they seek
Describe the solution you'd like
Consider adopting a framework like https://diataxis.fr/
Diátaxis posits there are four modes of documentation, each serving a clear use-case along the 2 dimensions of "theory vs practical" and "study vs application"

Describe alternatives you've considered
AI
Additional context
Intent is not to switch all the docs over to this framework, but to consider using this framework when creating new docs and improving iteratively towards a clear guideline. Having a framework like this in mind helps guide the reader when they land on the docs page AND it helps doc authors with where to place new content and what to write there.
The text was updated successfully, but these errors were encountered: