Functionality Documentation - Clarity Issues

[nuclearGoblin]

From matthewfeickert in openjournals/joss-reviews#3174 on 04/29/21

Typos in the documentation should be checked for and corrected. There is some brief description of the custom .txt file format (the "levelfiles") but it is not well formatted for Markdown and lacks a full description of the schema and clear examples. There are also what appear to be "TODO"s written by the authors to themselves

Check that the below is correct!

that should be removed.

Description: There are issues with spelling/grammar or other typoes, there are leftover "TODO"s, and the the levelfile documentation is unclear.

Solution: Check spelling/grammar and leftover "TODO"s and work on the writing and formatting for levelfile documentation.

Testing: N/A (Documentation)

[nuclearGoblin]

I have checked the README over for typos already and found a few, but I'm not sure I found all of them. @villaa would you be willing to help me look for them? Thanks!

• [x] Check for spelling/grammar/other typos I have done this but I am not confident that I found all of them - will treat this as an ongoing task until the other parts are completed.
• [X] Clear leftover "TODO"s. I checked for these and found two - both have been completed and removed.
• [x] Work on clarity of both writing and formatting of the levelfiles. Provide schema and clear examples. I will start on this rework once we finish 1.0.4 so I can use the pull request workflow instead.

[villaa]

Addressed fully in PR #20