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

[EPIC]: Improve documentation content by adopting diataxis #2841

Open
gonidelis opened this issue Nov 15, 2024 · 0 comments
Open

[EPIC]: Improve documentation content by adopting diataxis #2841

gonidelis opened this issue Nov 15, 2024 · 0 comments
Assignees
@gonidelis
Labels
2.8.0 target for 2.8.0 release doc Documentation-related items.

Comments

@gonidelis
Copy link
Member

gonidelis commented Nov 15, 2024 •
edited
Loading

As mentioned in #2327 we have decided to elevate our documentation content by compartmentalizing its structure into:

  • Tutorials
  • How-to guides
  • Elaborate explanations
  • API Reference

according to diátaxis.

Here is a very rough (unfinished) map of what I envision our docs to look like.

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

@gonidelis gonidelis

Labels
2.8.0 target for 2.8.0 release doc Documentation-related items.
Projects
CCCL
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gonidelis @jollylili