trillek-team / tec

The Trillek Engine
http://trillek.space
GNU Lesser General Public License v3.0
138 stars 21 forks source link

Added docs starter #207

Closed adam4813 closed 3 years ago

adam4813 commented 3 years ago

Adds a starter setup for mkdocs to begin documenting lua API in repo.

Description

Motivation and Context

Having a centralized in repo docs is super important for being able to move to a new hosted platform if the need arrives. Additionally this provides a central source of truth for docs.

The plan is to try a service such as https://readthedocs.org/ to provide a hosted copy as well.

How Has This Been Tested?

Docs have been server locally via mkdocs serve and appear similar to the included screenshot

Screenshots (if appropriate):

Types of changes

Checklist: