-
Notifications
You must be signed in to change notification settings - Fork 212
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
Have a wiki for the items #1943
Comments
Related: #1677 |
One of the tricky things about docs is trying to find how to structure them so information is easily findable, but not also not duplicated in too many places. We've definitely not got that right yet. I'm not sure if item-based pages are a help or a hindrance here. On one hand, it's a useful place to document behaviour that doesn't belong to an API (such as dying turtles), but on the other hand it does mean information is more spread out across pages (do I look in the 'turtle API' or the 'turtle item' page). It is going to be tricky to avoid having such pages just be a list of things. But I guess maybe that's fine — most of the rest of the docs is "Reference" documentation, so I guess it makes sense for item pages to be too. I think #1677 is trying to solve a different problem — that's more around tutorials/guides. |
I recently found out that simple "dump" page of information is often enought to satisfy this need : https://github.com/Tiviacz1337/Travelers-Backpack/wiki for instance I can get pretty much all the info I need about the mod (craft, item's usage, ...) my guess is that it would fit in the "reference" section of the tweaked.cc page. For instance a "crafting" section and a "particularity" section would answer most questions. I actually had trouble finding craft too and this was the first section I checked. |
Maybe you could add unorganized information in the Github Wiki first. Just explain to players the items, forget about perfectness. It's rather more upsetting to know absolutely nothing about them. |
To be clear, this was a genuine "I don't know" (I know sometimes this reads as a "it's a bad idea, but let's present both sides"). What I'm mostly trying to acknowledge here is that writing documentation is a lot of work — I don't want to dive into writing more things, if half of it ends up being useless! I think probably a better thing to do now is if we build a list of what things aren't documented and/or are confusing to find right now, and then work out how to organise this later. Off the top of my head, I can think of: General
Computers
Disk drivesHonestly, the docs here are shockingly bad. There really should be more information about the motivation for them.
Pocket computersAgain, docs here are incredibly perfunctory.
Turtles
PrintersAgain, this whole page is very bare-bones.
|
Wh- But- But you're the one who told me I should post an issue here ;-;
100% with you on this one, unorganized documentation is better than no documentation (Ctrl+F comes in handy in this case)
I guess that would be a good start. Maybe have a thread or a form of some sort somewhere, were anytime we search and don't find an information in the wiki (even with that search bar), we add to the list? |
I think this was more of a "see also", rather than a "this is a duplicate".
Oh, I was just planning to co-opt this issue for that, but also happy if people just want to file a new issue. |
I agree - with an wiki like MC wiki we could integrate it with HeyWiki too |
Useful information to include:
The text was updated successfully, but these errors were encountered: