doc: leverage #18 for docsify-based module documentation #65
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- update README to the new default module readme format (see `Health` for example) - add index, sidebar and assets for docsify - add some first documentation pages
skaldarnar
reviewed
Apr 18, 2021
docs/index.html
Outdated
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>TeraNUI</title> |
There was a problem hiding this comment.
not sure what I put here for Health 🤔 maybe Terasology/GooeyDefence?
skaldarnar
reviewed
Apr 18, 2021
| They spawn in the outer areas of the gameplay arena and try to traverse it to reach the shrine in the arena center. | ||
|
|
||
| Currently, Gooeys do not spawn automatically. | ||
| A wave of Gooeys can be triggered by interacting with the shrine in the center of the arena (`E`) or by using a held item (right-click). |
There was a problem hiding this comment.
fun fact - you can use <kbd>E</kbd> to denote keys: E
skaldarnar
reviewed
Apr 18, 2021
docs/towers.md
Outdated
Comment on lines
22
to
29
| | Effector | Effect | Notes | | ||
| ------------------------------------------------------------------------- | ||
| | DamageEffector | Plain Damage | direct damage only | | ||
| | FireEffector | Burn Damage | damage over time, chance of spreading | | ||
| | IceEffector | Slow | | | ||
| | PoisonEffector | Poison | damage both direct and over time | | ||
| | StunEffector | Stun | | | ||
| | VisualEffector | Enlarge | increases enemy visibility | |
There was a problem hiding this comment.
this table does not render correctly. same for the one below:
There was a problem hiding this comment.
the pipe | is missing in the horizontal divider line.
skaldarnar
reviewed
Apr 18, 2021
docs/_sidebar.md
Outdated
| * [TowerScreen](tower-screen.md) | ||
| * [Parsers](parsers.md) | ||
| * API | ||
| * [API](http://jenkins.terasology.io/teraorg/job/Terasology/job/Modules/job/G/job/GooeyDefence/job/master/javadoc/overview-summary.html) |
There was a problem hiding this comment.
this module does not have a master branch, therefore this link is broken. I'm not sure what the correct link to the last "release" would be, maybe best to just remove this.
Suggested change
| * [API](http://jenkins.terasology.io/teraorg/job/Terasology/job/Modules/job/G/job/GooeyDefence/job/master/javadoc/overview-summary.html) |
skaldarnar
approved these changes
Apr 18, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Healthfor example)Outstanding:
Co-authored-by: oniatus oniatus@googlemail.com
Co-authored-by: Quinn Roberts quinn@jelly-snakes.com