search

sslab-gatech / opensgx

OpenSGX
Other
288 stars 80 forks source link

Publish docs instead of pdf user manual #29

Open jonhoo opened 8 years ago

jonhoo commented 8 years ago

It would be really useful to have proper documentation for OpenSGX. The user manual/tutorial is a good start, but it'd be great if it were in a more digestible format such as ReadTheDocs, or simply as regular text-based files. I don't see a particularly good reason for serving it as a PDF?

johnmwshih commented 8 years ago

I also agree with using text-based instead of PDF. Probably because there are some graphics. I think we can simply make a text-based version.

jonhoo commented 8 years ago

That'd be great! The best would be if the documentation was in the code and then generated using something like Sphinx, which is also supported by ReadTheDocs, so you can get nicely formatted, indexed, cross-linked, and searchable docs.

jonhoo commented 8 years ago

6cc1fe695b61bd34eed199402b8ea575a6fe49ed is a step in the right direction.