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

Add Diátaxis mention in the documentation section #1145

Open

ezio-melotti opened this issue Jul 27, 2023 · 0 comments

Assignees

Labels

enhancement guide-new content topic-documentation

Member

ezio-melotti commented Jul 27, 2023

We have been following the Diátaxis framework for a while now, with good results, however there are no mentions of it in the devguide. We should add a short section about it in https://devguide.python.org/documentation/start-documenting/ with a link to that section in https://devguide.python.org/documentation/style-guide/.

ezio-melotti added the enhancement label

Jamesgo1 mentioned this issue

gh-1145: Add an overview of Diátaxis to the style guide #1177

Merged

willingc added guide-new content topic-documentation enhancement and removed enhancement labels

willingc self-assigned this

ambv pushed a commit that referenced this issue


          gh-1145: Add an overview of Diátaxis to the style guide (#1177)

1a56667

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment