hyperlight-dev / hyperlight-dev/hyperlight
Improve the documentation for the `guest_dispatch_function` in the C and Rust Guest APIs
Open
area/documentation
lifecycle/confirmed
- Dominant language
- Rust
- Stars
- 4.7k
- Forks
- 208
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 47
Description
The hyperlight guest library defines a function called `guest_dispatch_function` which allows the guest to dynamically dispatch calls to functions, this function is not really documented anywhere. We should document this function more clearly explaining its purpose and how to use it.
More generally we should improve [this](https://github.com/hyperlight-dev/hyperlight/blob/main/docs/how-to-build-a-hyperlight-guest-binary.md) documentation to describe how to build a guest.
Contributor guide
Assessment
This issue has not been assessed yet.