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

Make DTS documentation more user friendly #337

Closed
TomaszAIR opened this issue Feb 17, 2023 · 4 comments
Closed

Make DTS documentation more user friendly #337

TomaszAIR opened this issue Feb 17, 2023 · 4 comments

Comments

@TomaszAIR
Copy link

The documentation for DTS provides lots of stuff like

  • flashing
  • building
  • features description
  • etc

Some of them are definitely not user friendly as using it needs some technical knowledge.

What we would like to achieve is to create docs by following principals similar to ones, described in Diataxis[1].

We could logically divide docs that are for users, developers, technicians etc.

[1] https://diataxis.fr/

@sulewskiprzemyslaw
Copy link

Issue mentioned in the latest DTS PR: Dasharo/docs#369 (comment)

@TomaszAIR
Copy link
Author

As part of this task, we should carefully review the documentation and make sure that the usability part (downloading DTS, using it, deploying Dasharo, etc.) is described in a clear way, understandable to anyone who wants to try Dasharo. For example, commands like grep, wget, cd should be described in detail, in case they are read by someone who has never dealt with Linux or the terminal.

@macpijan
Copy link
Contributor

As long as we require users to use commands such as grep or wget to update their firmware, it will never be user-friendly.

Teaching the Linux shell commands in documentation is not a good path forward.

@artur-rs
Copy link
Member

artur-rs commented Dec 3, 2024

Scheduled related issue: #352
This one will be closed as duplicate/based on the comment #337 (comment)

@artur-rs artur-rs closed this as completed Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants