oak icon indicating copy to clipboard operation
oak copied to clipboard

Docs issue : docs link in README takes to 404

Open hackertron opened this issue 6 months ago • 2 comments

Hello , I was going through the project , the doc link is broken in README : https://project-oak.github.io/oak/rustdoc .

Also I would love to build a MVP or anything small on Oak , but I can't find the documentation for it. Is there a gitbook or hosted documentation anywhere.

thanks

hackertron avatar Jun 24 '25 00:06 hackertron

Thanks for pointing out the broken link. We have stopped publishing generated Rust documents a while ago and forgot to remove this link.

We don't have open source "getting started" documentation yet. Our onboarding efforts so far has been internally focussed.

If you are looking to build something using the Oak Restricted Kernel, a good starting point (at least for the enclave app) is to look at https://github.com/project-oak/oak/tree/main/codelab. To actually run the enclave app requires a launcher to create a VM and load the application. It should be possible to use https://github.com/project-oak/oak/tree/main/oak_restricted_kernel_launcher to just run it, but that would not set up the communications channel to proxy requests into the VM to exercise the service inside.

We have an internal task in our task tracking system to add more documentation and provide a launcher implementation that is specific to the echo example in the code lab, but I am not sure when that will be prioritised.

conradgrobler avatar Jun 25 '25 15:06 conradgrobler

thank you for the quick response , hmm I see . If I managed to setup something and working, I will be happy to share my learning in the repo if you allow contributions

hackertron avatar Jun 25 '25 17:06 hackertron