-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc site on readthedocs? #117
Comments
The documentation of SwissCovid and the respective backend systems can be found here: https://github.com/admin-ch/PT-System-Documents |
@UBaggeler Issues have been raised concerning the completeness of that documentation repository and its confirmity to the current version. "Documents [5] describe the DP3T scheme but not the SwissCovid one. Actually, most of the DP3T scheme is replaced by GAEN and the part of the architecture related to theserver is nearly not covered at all.The repositories of theGAENAPI contains a sample code for an app and for a server.The GAEN API has no source code available but is fully documented." Prof. Vaudenay's report, pages 8 and 9. What is your take on this? Have these questions been addressed? Are there any plans by the EPFL team or Ubique to fully align the documentation with the state of the application, as well as provide more explanations, etc.? |
We are actively working on improving the documentation of SwissCovid and the DP3T-SDK. Please see https://github.com/admin-ch/PT-System-Documents to get a better overview over the whole architecture (also server) and how EN is used. If this does not answer your questions, let us know. |
Thanks a lot for these documents, which are interesting. We would like to have "hands-on" documentation. Particularly, step-by-step procedures, which describe how to independently compile and test both the back-end and client apps (android and IOS), so as to perform our own tests. Since there are github repositories that should be possible? |
Yes, all necessary parts are available here on Github. The README of each repository should tell you how to compile and run it. If you've got specific questions, we will try to answer them (and improve the README). |
I am aware of that, but I have not found instructions on how to download and integrate the SDKs of Google and Apple (which I guess is free and easy to get, since the software is open source and open to scrutiny).
Perhaps I didn't look well enough, could you give us a link?
In general, could give us a link to a clear, step-by-step how-to from A to Z? So that a person moderately skilled could do that?
|
I could not find a website with documentation (readthedocs, etc.), clearly explaining what the app is doing and how it works.
Any plans to publish one in the next days?
The text was updated successfully, but these errors were encountered: