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

Update current docs to follow the Diataxis approach #1095

Open
R-Lawton opened this issue Jan 7, 2025 · 0 comments
Open

Update current docs to follow the Diataxis approach #1095

R-Lawton opened this issue Jan 7, 2025 · 0 comments

Comments

@R-Lawton
Copy link
Contributor

R-Lawton commented Jan 7, 2025

WHAT

Review the current docs to categorise them into 1 of the 4 Diataxis types. This may not be clear in all cases and may require deeper investigation than an initial review, in particular if a document fits into more than 1 type.

For example, hand holding like a tutorial mixed into a guide (here are some examples of this).

Outcomes of this will be:
Site nav changes for docs that are not in the most appropriate place. For example, put all guides in ‘How-to Guides’ and reference material in ‘Concepts and APIs’.
Updates to docs that don’t fit a singular purpose. This could mean splitting the doc into 2 or more docs, or rewriting it to have a single focus.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant