cfpb / hmda-pilot

Creative Commons Zero v1.0 Universal
6 stars 8 forks source link

Create FAQs for developer questions #374

Closed pkaplan closed 9 years ago

pkaplan commented 9 years ago

As a developer at a bank, I would like a resource on the site that provides developer-level information regarding HMDA edits and explains how to use APIs available to bank developers

Tasks for this story:

poorgeek commented 9 years ago

Since this project is hosted on github, as a developer I would expect the developer documentation to live as a markdown file here rather than as a page with the site. We certainly could so something similar to what we did with the About or FAQ pages and include them in both places, but it might be better to keep the links on the site focused on the site functionality and developer documentation in github. We could also link to the developer docs from the FAQ with questions like "Does the HMDA Pilot have an open API?" and/or "Where can I find out more information about file edit specs you're using for validation?".

Maybe we could also add a fork me on github ribbon as a way to signify that the project is open-source and has more information available on github?

ericspry commented 9 years ago

I agree with @poorgeek - the docs should be in MD on the git repo, and a link from the FAQ would probably also be useful.