Please submit a pull request with any documentation changes you may find!
Any time a new commit is pushed to the remote master branch, Jenkins will run Slate (our API documentation generator) and convert the index.html.md file into HTML. This HTML can be viewed at https://bitgo.github.io/bitgo-docs/.
Steps to Update Documentation at https://bitgo.github.io/bitgo-docs/
- Review
index.html.md, making sure the changes are correct arc diffthe changes for review, and then land it once it's accepted- Go to https://bitgo.github.io/bitgo-docs/ to make sure HTML is correct
- Perform the above steps for updating the docs at https://bitgo.github.io/bitgo-docs/
git checkoutthegh-pagesbranch, which will contain the files and directories generated by Slate- Copy all folders and files into the BitGo client repository's static/api/ directory
- Run the server locally and go to http://localhost:3000/api and make sure the HTML is correct
- Create a diff in the BitGo client repository and land it once it's accepted