Lua scripted API docs

We have an internal platform where folks can create content for the game. All the complexity of Unity is taken away and replaced by a lovely Lua API. The only problem was that there were no docs.

Folks had to either look at existing objects, dig into prototypes, wade through the Go codebase… or, worst of all, interrupt our devs on Slack 😱

I created comprehensive documentation for the Lua API. I read the Go code that handles Lua bindings, then wrote up docs explaining classes, functions, and properties. I added parameters, returns, and an example for each function.

I wrote definitions in JSON files that lived alongside the Go code. I worked with a dev to create a Python script that converted these JSON files to Markdown. After this, Mkdocs Material rendered those Markdown files and created a static website.

To make sure that our documentation is consistent and welcoming to everyone, I added Vale to our workflow. I used Google’s developer style guidelines, as well as creating some in-house rules to catch common mishaps.

This was a large project, so I worked with a project manager to organize tasks. I tracked progress using Jira.

I worked with developers throughout, using pull requests in GitHub to ask questions and get feedback.