Restructure the Readme, improve Getting Started and explanations.
Leaving as Draft PR until we can update the "TODO"s
What we may want to change:
Link to docs may be easy to miss (i think it's ok as long as we can find it easily when we need it)
Added more links to the documentation, but we may want some more
I have moved the examples more to the bottom => is it ok or should we display them more
Rust -> we may want to display it more
When reading the readme, I can think of some questions one may ask: (i expect them to be the top questions)
=> we may want to put them in the FAQ section in the docs :)
Does my CPU work with Intel SGX? Which one are OK? => we may want a whole documentation page about that and link it in the readme
What about speed? Is inference slow on a CPU?
Want to learn more about how SGX works (technical audience, with lower level explanation that what our blogposts provide)
threat model for Intel SGX in general => is this secure against physical attacks and stuff
Related Issue
None
Type of change
[x] This change requires a documentation update
[ ] This change affects the client
[ ] This change affects the server
[ ] This change affects the API
[x] This change only concerns the documentation
How Has This Been Tested?
N/A
Checklist:
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] My changes generate no new warnings
[x] I have updated the documentation according to my changes
Description
Click to see the rendered version
Restructure the Readme, improve Getting Started and explanations.
Leaving as Draft PR until we can update the "TODO"s
What we may want to change:
Related Issue
None
Type of change
How Has This Been Tested?
N/A
Checklist: