-
Notifications
You must be signed in to change notification settings - Fork 16
Add developer documentation #6
Comments
Since development over in client land is proceeding, this is worth adding to the next sprint. Note that we should add these docs to the main SecureDrop repository since:
|
We're not officially releasing this SDK in 0.10.0 as we need to at minimum have documentation in the SecureDrop docs regarding how to use this project, and how to contribute to it. In addition we should include the following SDK-related notes in the documentation:
We can consider/discuss adding integration tests in CI (though this only covers the HTTP case and not the securedrop-proxy case without some additional work), but until then we need to do the above steps to prevent bugs from being merged or drift between the SDK and the server logic. |
I think it would be useful to remove |
this was done |
As part of the first release of the SDK, we should document it for developers, including:
Scaffolding exists in https://github.com/freedomofpress/sdclientapi/tree/master/docs which needs to be built out.
The text was updated successfully, but these errors were encountered: