This is the documentation template for GSA APIs.
This provides a consistent look and feel across our APIs throughout the organization. API developers will be able to follow through a standard process for creating and publishing APIs. API consumers will appeciate consistent documentation style.
Thanks to CFPB team for creating this model and for furthering open source in government. Additional inspiration from the 18F and the SAM (IAE) teams, as well as Kin Lane.
Currently this template is configured to work on GitHub pages. The easiest way to use this template is by forking this repo and using it as a starting point for your own project. You can keep the doco in its own repo, or include your project's code in the same repo.
Take whatever you you like about it and make it your own!
If you choose to use this template in some other fashion, please let us know by adding an issue in this project's issues. We would like to keep track of how it is benefitting other projects.
Please feel free to add issues and pull requests for any recommendations you think would be worthwhile for all users of the template.