Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adopt Diátaxis framework for CBL-Mariner documentation #6828

Open
christopherco opened this issue Nov 22, 2023 · 0 comments
Open

Adopt Diátaxis framework for CBL-Mariner documentation #6828

christopherco opened this issue Nov 22, 2023 · 0 comments
Labels
feature-request Request for a feature or enhancement

Comments

@christopherco
Copy link
Contributor

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"
 
image

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.

@christopherco christopherco added the feature-request Request for a feature or enhancement label Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for a feature or enhancement
Projects
None yet
Development

No branches or pull requests

1 participant