Explore different API documentation platforms

coralproject / ask-docs

Official Ask Documentation for The Coral Project

https://docs.coralproject.net/ask/

Other

11 stars 14 forks source link

Explore different API documentation platforms #49

Closed aiboyles closed 7 years ago

aiboyles commented 7 years ago

David pointed to Swagger as an attractive documentation platform specifically for APIs. While I'd prefer to keep everything on one platform in one place, I agree that for larger APIs like Pillar it may be worth turning to an API-specific platform. I'll take a look at Swagger and Slate and see what we might want to use and how that can fit into our current documentation.

sfphoenix commented 7 years ago

+1 on Swagger

kgardnr commented 7 years ago

Closing, will turn into stories to implement Swagger for automated API documentation.