Add docs #318
Add docs #318
Conversation
technic/doc/chests.md
Outdated
|
|
||
| ## Sorting | ||
|
|
||
| Chests can be sorted with one button with the following sort types : natural sort, by item, by quantity, by tipe or by wear. The chests can also be sorted automatically when its content changes. |
There was a problem hiding this comment.
| Chests can be sorted with one button with the following sort types : natural sort, by item, by quantity, by tipe or by wear. The chests can also be sorted automatically when its content changes. | |
| Chests can be sorted with one button with the following sort types : natural sort, by item, by quantity, by type or by wear. The chests can also be sorted automatically when its content changes. |
There was a problem hiding this comment.
There are actually three buttons, one to change the sort method, one to sort, and one to toggle auto-sorting (except for iron chests, which lack auto-sorting).
Really the chest docs need a lot more changed, particularly when it comes to the mithril chests (which is what the "Chest digilines functionality" task is about).
There was a problem hiding this comment.
Additionally chests documentation should probably be moved under chests mod instead of keeping it in technic mod.
I think it would probably be better to create another PR just for chests documentations.
technic/doc/digilines.md
Outdated
| @@ -4,6 +4,10 @@ | |||
| This document describes the interaction of | |||
| technic machines with the `digilines` mod (https://github.com/minetest-mods/digilines) | |||
|
|
|||
| ## Digicables | |||
|
|
|||
| Digicables are a new type of cables that bring both electricity power and digiline-based information (analogic). Like both original types of cable (electric cable and digiline), you just have to connect cables to each other in order to transmit power/information. They are needed to access nuclear reactor digiline information (through the bottom). The digicables are available in HV, MV and LV. | |||
There was a problem hiding this comment.
Maybe just drop "new", reactor does not have to be bottom, also few other suggestions.
| Digicables are a new type of cables that bring both electricity power and digiline-based information (analogic). Like both original types of cable (electric cable and digiline), you just have to connect cables to each other in order to transmit power/information. They are needed to access nuclear reactor digiline information (through the bottom). The digicables are available in HV, MV and LV. | |
| Digicables are a type of cable that carry both electric power and digiline messages. Like both original types of cable (electric cable and digiline), you just have to connect cables to each other in order to transmit power/information. They are needed to access nuclear reactor digiline information. The digicables are available in HV, MV and LV. |
I think important thing to add would be crafting because it needs alloying and therefore might not be that obvious especially if crafting guide isn't able to display alloying recipes (or if playing without guide).
There was a problem hiding this comment.
But then also, recipes maybe do not belong here in this file. Not sure if those are already somewhere but probably not...
There was a problem hiding this comment.
IMO it's better not to document recipes, because they can often be different. Servers change recipes quite often.
It should state the difference in connecting rules though, digicables connect differently than standard digilines.
There was a problem hiding this comment.
I've not actually ever seen a single change in any of special recipes (that are not crafting which in turn works in all guides). Probably those too have changed outside the mods but definitely not often.
There was a problem hiding this comment.
Yeah, probably a bad assumption, but I have seen recipes changed. I do remember some technic recipes changed on Tunnelers' Abyss for example.
There was a problem hiding this comment.
technic recipes changed on Tunnelers' Abyss for example.
They're not using either Technic plus nor original Technic mod, they're using their own fork which has their own documentation. Same goes with all of the servers I've seen changing their recipes.
|
|
||
| <img src="../textures/technic_multimeter.png"/> | ||
|
|
||
| This electric tool is used for quick lookup at an electric network. It works by clicking on an electric node (cable, machine, generator, switchting station), and gives values about : the position of the attached switching station, its current status, the lag, the batteries, the supply and the demand, and the total of each type of node. |
There was a problem hiding this comment.
For multimeter it would be very good to actually document values it displays, few are obvious but many are not if player isn't very familiar with technical stuff under the hood.
Maybe table with descriptions for each value displayed by multimeter.
|
I followed your suggestions, but I wrote basic meanings for "Timeout" and "Skip" because I'm not sure what it really means. |
technic/doc/tools.md
Outdated
|
|
||
| | Property | Example Value | Unit | Meaning | | ||
| |------------------|---------------|------------|---------------------------------------------------------------| | ||
| | Ref. point | 61, 19, 62 | Coordinate | The location of the switching station attached to the network | |
There was a problem hiding this comment.
This actually isn't pointing to switching station but 1 node below it which is cable.
While it is very often directly below switching station this is not always the case, there does not have to be switching station above it.
Actually this information is technical detail that isn't too simple when you dive into it.
Reason it is included is that I first created multimeter to aid debugging during development but just tried to make it also usable by regular players.
There was a problem hiding this comment.
Not sure what to change in description though... Network ID is derived from this coordinate (for both actual network implementation and for ID that shows up in multimeter).
Coordinate is also used with administrative commands, same location those commands will show.
|
Corrected the docs following your suggestions, notably multimeter properties table. Now waiting for approval. |
|
When you think it is ready, mark as ready for review taking PR out of the draft state. Currently however this probably would not yet be enough to close #53 so either closing keyword should be removed or rest of it implemented (at least what is listed on #53). |
|
We might as well keep this as a draft until it's complete, there's no rush, the documentation isn't a blocker for 2.0.0. @Athozus do you mind if I add to this PR? I can at least do the chests and quarry docs, as those are two parts of the mod I know well (because I designed and wrote the code of the new versions). |
Was too fast, forgot that there was still docs for polyfuse, overload and chests digilines. I don't know what means all those, the behaviour, ... so I need someone to explain me a bit, or write the doc. |
add what you want to the PR, np (i may squash my commits later) |
|
I added some explanations based on @S-S-X's ones to me. I hope it will okay for that time. |
|
I just saw back this one. @S-S-X @OgelGames are you approving for merging ? Are there still changes to do ? |
|
Also rebase first, simplest way to do this is "Update branch"-button and select "Update with rebase" option. |
Click for detailed source code test coverage reportTest coverage report for Technic CNC 87.36% in 11/14 files:Test coverage report for technic chests 45.49% in 6/6 files:Test coverage report for technic 66.04% in 96/96 files:Raw test runner output for geeks:CNC: Chests: Technic: |
|
Should be able for approval now. |
|
Yeah, it would be nice to have everything fixed in one PR, but it's been too long to keep this waiting. |
Based on @BuckarooBanzay post :
digilinesfunctionalityI didn't added the non-checked documentations because I don't know what you mean with, so I also made this PR as a draft.
EDIT : I've added those in the commit de3e6b9
Helps with #53