Really like the Rust example, might use that as a template. I am thinking of using a simple pong game to get started. Thank you for all the suggestions as well.
PandaInSpace
- 1 Post
- 8 Comments
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?2·1 month ago
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?2·1 month ago
This is also a really good resource, thank you for sharing. Idk why I didn’t think about KDE apps docs before making this post. Thanks!
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?2·1 month ago
Idk who Jack Webb is 😅, but I agree with you, I’m not thinking of flowery prose, but basic steps and instructions for a beginner to get started. Thanks!
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?2·1 month ago
There’s nothing other than a basic readme with build instructions. I guess Godot docs might be a good place to start. Thanks!
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?3·1 month ago
That’s actually a great suggestion. Thanks for sharing that book as well, it appears to go really in depth.
I’ll try searching and will update the post with any good resource I find as well
- PandaInSpace@kbin.earthOPtoOpen Source@lemmy.ml•Any resources on how to start writing documentation for an open source project ?1·1 month ago
Haven’t come across this, thank you for sharing! I’ll take a look
- PandaInSpace@kbin.earthtoOpen Source@lemmy.ml•Fred TV 2.0: Ultra-Fast Open-Source IPTV app, now will full Android TV support and much more!7·1 month ago
Will it be on f-droid ?
Damn wasn’t expecting this to get philosophical lol. Good points, I didn’t think of documentation through this lens, I was just thinking of writing basic instructions, which might not be as easy for a beginner to understand.
My initial idea was just to use a blog, but it might not be easy to find for people new to the project and having docs as a repo might also allow the devs to change anything when they want as well.