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

Investigate applying the Diataxis model to the documentation layout #1312

Open
Zeitsperre opened this issue Mar 6, 2023 · 2 comments
Open
Assignees
Labels
docs Improvements to documenation standards / conventions Suggestions on ways forward
Milestone

Comments

@Zeitsperre
Copy link
Collaborator

I find "ALL MODULES" > xclim and "USER API" > API sections redundant.

In the long run, it could be interesting to divide the documentations into categories to group doc pages that belong together. It could be categories such as the ones proposed in diataxis. It's really tedious to do on the existing doc, though.

Originally posted by @bzah in #1308 (review)

@Zeitsperre Zeitsperre added standards / conventions Suggestions on ways forward docs Improvements to documenation labels Mar 6, 2023
@Zeitsperre Zeitsperre self-assigned this Mar 6, 2023
@Zeitsperre Zeitsperre changed the title Invetsigate applying the Diataxis model to the documentation layout Investigate applying the Diataxis model to the documentation layout Mar 20, 2023
@Zeitsperre Zeitsperre added this to the Summer 2023 milestone Mar 21, 2023
@Zeitsperre
Copy link
Collaborator Author

To do: Divide this into sub-categories.

@coxipi
Copy link
Contributor

coxipi commented Nov 27, 2023

So do we want to apply this approach to notebooks too? I would say that current notebooks are currently much more oriented towards "practical steps". But perhaps this comes quite naturally with the notebook format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements to documenation standards / conventions Suggestions on ways forward
Projects
Development

No branches or pull requests

2 participants