Possbile docs Improvements #5957
Replies: 5 comments 3 replies
-
I think the install instructions could be less fractured and maybe a bit more concise. |
Beta Was this translation helpful? Give feedback.
-
Regarding installation - the docs for the package installer need attention. A number of users have struggled with using the special cli syntax vs normal invoke |
Beta Was this translation helpful? Give feedback.
-
Maybe also the style can be improved to match with the new platform ui theme and be a bit more modern. Comparing them to other OSS docs like gitea the look pretty old in my opinion and the UX on mobile is not that great. |
Beta Was this translation helpful? Give feedback.
-
Hi everyone. I'm a techwriter with a few years of experience and I'm trying to contribute to open source documentation to create a portfolio that I can share publicly. I reached out to @matmair and he was open to the idea of me reviewing the docs and proposing some changes. Note, that I'm no expert in this domain, rather documentation in general. |
Beta Was this translation helpful? Give feedback.
-
Restructuring all the docs to fit this pattern would probably also improve them a lot https://diataxis.fr/ |
Beta Was this translation helpful? Give feedback.
-
Where can the docs be approved? What docs are missing/confusing?
Beta Was this translation helpful? Give feedback.
All reactions