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.

Sign up for GitHub

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

Jump to bottom

Update documentation to reflect diataxis framework #1368

Open
marc-vdm opened this issue Sep 23, 2024 · 0 comments
Open

Update documentation to reflect diataxis framework #1368

marc-vdm opened this issue Sep 23, 2024 · 0 comments
Labels
documentation PRs that refer to documentation at any level (code, readthedocs, etc.)

Comments

@marc-vdm
Copy link
Member

marc-vdm commented Sep 23, 2024 •
edited
Loading

This shouldn't be major, just nuanced changes in how/where we organize the documenation. Specifically 'how to' should be figured out.

divide documentation into:

  • Tutorials
  • How tos
  • Explanation
  • Reference

The first three should go on the wiki, the last should go in the code

reference: https://diataxis.fr/
@marc-vdm marc-vdm added the documentation PRs that refer to documentation at any level (code, readthedocs, etc.) label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation PRs that refer to documentation at any level (code, readthedocs, etc.)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marc-vdm