Terasology / Behaviors

Store for an assortment of behaviors that can be applied to creatures
https://terasology.github.io/Behaviors
6 stars 18 forks source link

doc: migrate wiki to docsify page #106

Closed skaldarnar closed 2 years ago

skaldarnar commented 2 years ago

Similar to Terasology/Health#74 this PR moves the content of the wiki into the docs folder to be served as gh-pages powerd by docsify. This allows to edit and update the documentation alongside the code more easily.

I moved symlinked the README file to the docs folder, which works with both Github's web view and later in docsify as well. See https://github.com/skaldarnar/Behaviors. (The image is not rendered when viewing the symlinked file in Github, but we can probably accept that.)

However, I'm not sure of the interop with Windows checkouts of the repo :thinking: Looking at Git symbolic links in Windows on StackOverflow this seems to be a bigger issue I don't want to solve right now. The symlink can work under Windows if the respective setting is enabled when installing Git Bash for Windows, for instance. If not, the symlink is replaced with a file containing a reference to the target (which does not render perfectly, but also does not look like it will cause edit wars by accident).

A preview of the github pages view can be seen at https://skaldarnar.github.io/Behaviors/#/

Not blocking the PR from my view, but would be nice to have:

skaldarnar commented 2 years ago

Potential Follow-ups