hyperlight-dev / hyperlight-dev/hyperlight
Enable documentation for hyperlight_guest_capi generated header file
Open
area/documentation
lifecycle/confirmed
- Dominant language
- Rust
- Stars
- 4.7k
- Forks
- 208
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 48
Description
We have this disabled in the cbinggen.toml and should consider enabling it
https://github.com/hyperlight-dev/hyperlight/blob/9cb01743a7bf70bdc8513d25f0c68b5f62a9b918/src/hyperlight_guest_capi/cbindgen.toml#L6
Contributor guide
Research direction
Open src/hyperlight_guest_capi/cbindgen.toml at the referenced setting and inspect how documentation is currently disabled. Enable the setting if appropriate, then regenerate or inspect the hyperlight_guest_capi generated header to confirm documentation is included.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100