Videos taken from two sessions wherein Dave Mayo instructed working group members on how to add examples to the API documentation.
Session 1
A. adding documentation to endpoints in backend controllers:
| View filemultimedia |
|---|
| name | api_docs_training_1a_endpoints.mp4 | height | 250 |
|---|
|
B. Overview of backend code that processes API docs
| View filemultimedia |
|---|
| name | api_docs_training_1b_rest-rb.mp4 | height | 250 |
|---|
|
C. Overview of API documentation template
| View filemultimedia |
|---|
| name | api_docs_training_1c_api-erb.mp4 | height | 250 |
|---|
|
D. Review and Q&A
| View filemultimedia |
|---|
| name | api_docs_training_1d_review-qa.mp4 | height | 250 |
|---|
|
E. Building the API documentation:
| View filemultimedia |
|---|
| name | api_docs_training_1b.mp4 | height | 250 |
|---|
|
Session 2
Setting up for local development and doc-building, and making a pull request
...