nimiiiii/nimi-api

Documentation link on index page doesn't lead anywhere

sigmachirality opened this issue · 3 comments

title. is the documentation not implemented yet?

Documentation is currently being written. I'll keep this issue open for tracking.

Hey, it's been like half a year and there's still no documentation.
Also it seems that the endpoints have changed because api/ships/[id] doesn't seem to work and returns "Breakout level should only be between 1 and 4.".

I find it really hard to figure out how to use it just from the source code, so I'm waiting for the day the docs come out...
Like partial docs would be really cool too.

sr229 commented

Hey, it's been like half a year and there's still no documentation.
Also it seems that the endpoints have changed because api/ships/[id] doesn't seem to work and returns "Breakout level should only be between 1 and 4.".

I find it really hard to figure out how to use it just from the source code, so I'm waiting for the day the docs come out...
Like partial docs would be really cool too.

The team hasn't found a suitable solution to automate documentation, hence we haven't made any documentation releases yet. We're still focused on #13.