doc: merge wiki documentation into docs/ #74
Conversation
Merge the documentation given in the GooeyDefence wiki into towers.md. Closes Terasology#66
docs/towers.md
Outdated
| * a core block | ||
| * an effector block | ||
| * a targeter block | ||
| The first part of a tower is the core. These add power to the other two block types. |
There was a problem hiding this comment.
I'm wondering - in the wiki core here was a link to the sub-page on Cores. Would it make sense to make similar sub-pages in the /docs approach and come up with the right way to link pages that way? This otherwise becomes a pretty intense single page :-)
I'll mark this as a requested change, although I'm happy to just hear commentary, maybe my personal enjoyment of "little things" would push this into too-tiny-pages territory. Otherwise it is good to see some doc work happening?
Will leave my review stopped at this early point to first see about ideal next steps there.
There was a problem hiding this comment.
Yes, good point! The original towers.md had all the sections in together so it didn't occur to me to split it up, but hopefully this works.
create new files for each tower block type and link between them
There was a problem hiding this comment.
Thank you for the contribution and adjustments! 💚
The split up structure looks fine to me 👍
However, there's two things I'd like to request to be changed:
- Please add the new pages to the
docs/_sidebar.mdsuch that users can navigate to those pages without having to find the links in-text. - Please revisit your changes and instead of plainly overwriting the documentation that was there before-hand, compare it to the wiki documentation parts you add and leverage the information that is not provided there by integrating those parts of the current non-wiki documentation with the newly added information. (I left a respective exemplary suggestion on the towers page)
If you find contradictions, please ask and we'll help figuring out which information is the truth 🙂
| Gooey Defence is a tower defence gameplay template. This means that one of the most important features of the module is the towers that give the genre its name. In Gooey Defence, these are freeform multiblock structures, with a minimum of three parts. Together these parts allow players to build a wide variety of towers. | ||
|
|
||
| Towers are the multi-block structures that attack the enemies either by damaging them or affecting their stats. | ||
| A tower is made up of at least three blocks: | ||
| * a core block | ||
| * an effector block | ||
| * a targeter block | ||
| The first part of a tower is the [core](core.md). These add power to the other two block types. | ||
| Next are [targeters](targeter.md), which select and attack the enemies. They don't actually apply any damage or effects however. The last are [effectors](effector.md) which complement the targeters by applying effects and damage to the targeted enemies. |
There was a problem hiding this comment.
Let's merge the docs from the wiki with what was previously provided instead of just overwriting it.
For instance, my suggestion would be the following:
"""
Gooey Defence is a tower defence gameplay template. This means that one of the most important features of the module is the towers that give the genre its name. In Gooey Defence, these are freeform multiblock structures consisting of different parts. Together these parts allow players to build a wide variety of towers that attack the enemies either by damaging them or affecting their stats.
A tower is made up of at least three blocks:
- a core block adding power to other block types
- a targeter block selecting and attacking enemies
- an effector block applying effects and damage to targeted enemies
"""
Merge the documentation given in the GooeyDefence wiki into towers.md.
Closes #66