thesharks/wildbeastdocs

Documentation for WildBeast.

wildbeastdocs's Issues

Add full command reference

Because the native commandlist doesn't cut it for most people. This is a cross-project issue to WildBeast.

For this repo, a full command reference will be added.
For the WildBeast repo, a link to the full command reference in the docs will be added.

Tagscript docs

We use tagscript within the tag command, yet we aren't documenting it, the source code from tagscript has some documentation to get started with.
As of right now we don't have custom data points so only tagscripts internal functions are accessable.

Include website compiler + generated site

Include MkDocs in a requirements file that can be installed via pip. Upload the current website build into the repo. In the requirements, the mkdocs-material theme will also be specified. mkdocs.yml included for compilation.

An installation + compilation guide will be added. Required packages will be installed via pip.

In the future, all changes to the documentation must be compiled to an MkDocs test server and a quality check must be performed. If quality check passes, the static website needs to be compiled and included in the PR.

The final commit will update both the documentation and the website files.

Dockermentation

In line with TheSharks/WildBeast#176, we need docs on how to setup Docker.
In short, steps consist of installing docker and running docker-compose up in the folder wildbeast was cloned to.

Ensure that WB has all the descriptions, usage info etc. up to date

Some things like the customize help handle are static so they need to be checked for if the necessary changes have been made before releasing 4.2.0.

I'll take care of this myself later tonight but if anyone else in @TheSharks/wiki-team finds any discrepancies with the info there and on the review branch here feel free to update them on experimental in https://github.com/TheSharks/WildBeast.

Properly setup repository

Add documentation and built website pages.

Rule34 links broken

Wildbot posts them with an extra http: which breaks the hyperlinking. https://i.imgur.com/FdQJRBd.png