TaleSpire Dev Log 384
APIs truly are the gift that keeps on giving.
We've been hard at work iterating on the API to make it more consistent, usable, and intuitive, and let me tell you: It's always surprising just how much can change on things that I thought were final. But this time, for realsies now, most things are shaping up to their final form - and I'm sure I don't just say that because I've now started writing the documentation for all the individual API calls and don't want to have to start over if things change. Yes! It's not just playing around with formatting and figuring out how the documentation should look like; we're now actually writing texts for each of the currently 86 API functions!
Besides writing descriptions for each and every API function, type, and event, I've also drafted an index page with some Getting Started tips and links to all relevant information. It's not finalized yet, but I do have a mostly finished rough draft:
And for completion's sake, here's what the API function documentation looks like:
This may not look much different from the last screenshot from the API docs I showed in my previous dev log. And you are right! However, what is not shown here is that we now also have all subscribable events in those docs, as well as reverse links that list where certain data types are used to make jumping around the API easier.
Also, here's a sneak peek at the manifest documentation:
And while I have you here, a short snippet of some extra things we will provide:
Overall, it's all shaping up and we're getting dangerously close to a usable Alpha release. Here's to hoping this is true this time as opposed to over a month ago when I first thought this.
Anyways, I'll now hunker down and continue writing the documentation to make the API understandable to you, have a nice day!
Disclaimer: This DevLog is from the perspective of one developer. It doesn't reflect everything going on with the team
- Oldest ▾