CC: Tweaked

CC: Tweaked

57M Downloads

Have a wiki for the items

TotoShampoin opened this issue ยท 9 comments

commented

Useful information to include:

  • Basically the same as Minecraft Wiki, but for the items in CCT, much like the original one
  • It'd provide recipes (even knowing there's the crafting book)
  • It'd also provide useful informations about the computers, turtles and all that are otherwise unknown and unintuitive.
    • For example, the fact that turtles aren't compatible with non diamond materials (by default),
    • or that turtles can be used in a disk drive. Two things that were told to me, and not found out anywhere on the internet.
commented

Related: #1677

commented

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.

commented

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.

commented

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.

commented

I'm not sure if item-based pages are a help or a hindrance here

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

  • Pocket computer, turtle, and disk dying and undying.
  • Computers (and turtles and pocket computers) in disk drives. This is mentioned on the drive page, but perhaps it should be elsewhere too.
  • All the config options.

Computers

  • Computer recipes.

Disk drives

Honestly, the docs here are shockingly bad. There really should be more information about the motivation for them.

  • Disk recipes.
  • Disk drives playing Minecraft record disks.

Pocket computers

Again, docs here are incredibly perfunctory.

  • Pocket upgrades.

Turtles

  • Turtle tool specifics: for instance, mentioning limitations/features of the various tools, like tilling soil with a hoe, and how axes are entirely useless!
  • Turtle dying.
  • Turtle overlays. I kinda like that this is a bit of an easter egg, but probably should document it.
  • Dinnerbone turtles. This definitely is an easter egg, and probably shouldn't be documented, but mentioning for completeness sake.
  • All the turtle datapack features (as Wojbie mentions, see also #1677).

Printers

Again, this whole page is very bare-bones.

  • Some explanation of how to use this. #1677 mentions it would be neat to have a full tutorial about the printer, but we really need a basic "here are the slots, here's what you use for ink".
  • Placing printouts in item frames and lecterns.
commented

Related: #1677
@Wojbie

Wh- But- But you're the one who told me I should post an issue here ;-;

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.
@RrkwM

100% with you on this one, unorganized documentation is better than no documentation (Ctrl+F comes in handy in this case)

...
@SquidDev

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?

commented

Wh- But- But you're the one who told me I should post an issue here ;-;

I think this was more of a "see also", rather than a "this is a duplicate".

Maybe have a thread or a form of some sort somewhere

Oh, I was just planning to co-opt this issue for that, but also happy if people just want to file a new issue.

commented

I agree - with an wiki like MC wiki we could integrate it with HeyWiki too

commented

I agree - with an wiki like MC wiki we could integrate it with HeyWiki too

That would be easy to do since it requires adding files to a resource pack, CC-Tweaked already has a resource pack so the files can be added to that one.

HeyWiki also supports wikis not made with MediaWiki (the software that the Minecraft Wiki and Wikipedia uses) so the existing https://tweaked.cc site can be used without too much work.