Needs api documentation

[phenax]

The api is pretty simple but still a formal api documentation is required for the project explaining what the function does, it's example use cases and it's type signature. The documentation should be kept inside the /docs directory as markdown files.

[rjseymour66]

Hi I am a professional technical writer - can I contribute?

[phenax]

@rjseymour66. Definitely! If you have any questions regarding the specifics of the api, you can leave them on this thread.

[aredshaw]

Are you using REST APIs? If so, I might be able to help. I would need to know the base path and endpoints. Also, a list of possible methods and parameters. And of course an API Key if one is required.

[phenax]

@aredshaw, We're not using any REST APIs. Thanks for the offer tho!

[onluiz]

@phenax would it be a good idea to use gatsby? If so, I could've give it a try.

[phenax]

@onluiz This library only needs 1 page of documentation so I feel like gatsby would be an overkill. Just one markdown file documenting the api signature and usage example.

[Silks-road]

Hi there, I'm new to GitHub. While I've done aspects of technical writing in previous job roles, I'm now looking to get into technical writing professionally, which is why I'm trying to find open source RESTful API projects to help contribute documentation towards. I was wondering if you might have any issues that you may still need some help with?

[mearns]

Looks like this is done, is it not? @phenax

[phenax]

@mearns, @Silks-road, The docs have been added but improvements are always welcome. :smile: