Skip to content

docs: improve guest creation documentation - #1254

Merged
jsturtevant merged 2 commits into
hyperlight-dev:mainfrom
jsturtevant:rally/1191-make-it-easier-to-create-guests
Mar 11, 2026
Merged

jsturtevant merged 2 commits into
hyperlight-dev:mainfrom
jsturtevant:rally/1191-make-it-easier-to-create-guests

Conversation

@jsturtevant

Copy link
Copy Markdown
Contributor

Add a few more directions to readme and add some trouble shooting.

addresses #1191

Add a few more directions to readme and add some trouble shooting.

Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
Comment thread README.md Resolved

@ludfjig ludfjig left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. What do you think about adding a minimal (weekly?) test that tries to compile a minimal guest like the one I posted in #1175 using cargo-hyperlight? Maybe we can also link to it from the docs to show what a minimal guest looks like. I think it could be useful, and by making it weekly, we don't slow down existing stuff like just guests

@jsturtevant

Copy link
Copy Markdown
Contributor Author

LGTM. What do you think about adding a minimal (weekly?) test that tries to compile a minimal guest like the one I posted in #1175 using cargo-hyperlight?

Yea, maybe using the code from the readme would be a good thing since it isn't currently tested as is

@dblnz

dblnz commented Feb 25, 2026

Copy link
Copy Markdown
Contributor

LGTM. What do you think about adding a minimal (weekly?) test that tries to compile a minimal guest like the one I posted in #1175 using cargo-hyperlight? Maybe we can also link to it from the docs to show what a minimal guest looks like. I think it could be useful, and by making it weekly, we don't slow down existing stuff like just guests

Wouldn't the cargo-hyperlight repository be a better match for this?

@jsturtevant

jsturtevant commented Mar 11, 2026 •

Copy link
Copy Markdown
Contributor Author

Wouldn't the cargo-hyperlight repository be a better match for this?

we have one there: https://github.com/hyperlight-dev/cargo-hyperlight/tree/main/examples so maybe this isn't needed. but would be nice to have a test that validates our sample works.

@jsturtevant
jsturtevant merged commit 3a28293 into hyperlight-dev:main Mar 11, 2026
52 checks passed
@yoshuawuyts yoshuawuyts added the A-docs Related to documentation label Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-docs Related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants