Skip to content

docs: add comprehensive godoc documentation#379

Merged
JenGoldstrich merged 1 commit intomainfrom
docs/add-godoc
Sep 2, 2025
Merged

docs: add comprehensive godoc documentation#379
JenGoldstrich merged 1 commit intomainfrom
docs/add-godoc

Conversation

@tenthirtyam
Copy link
Copy Markdown
Collaborator

Description

Adds comprehensive documentation to all exported functions, types, and methods in the packages (common, iso, and vmx). Includes package-level docs, step methods, driver interfaces, and configuration structs. All documentation follows Go conventions for improved maintainability and developer experience.

@tenthirtyam tenthirtyam added this to the v2.0.0 milestone Aug 29, 2025
@tenthirtyam tenthirtyam self-assigned this Aug 29, 2025
@tenthirtyam tenthirtyam marked this pull request as ready for review August 29, 2025 14:20
@tenthirtyam tenthirtyam requested a review from a team as a code owner August 29, 2025 14:20
JenGoldstrich
JenGoldstrich previously approved these changes Sep 2, 2025
Add comprehensive documentation to all exported functions, types, and methods in the packages (common, iso, vmx). Includes package-level docs, step methods, driver interfaces, and configuration structs. All documentation follows Go conventions for improved maintainability and developer experience.

Signed-off-by: Ryan Johnson <rya@tenthirtyam.org>
@JenGoldstrich JenGoldstrich merged commit 46d75b7 into main Sep 2, 2025
14 checks passed
@JenGoldstrich JenGoldstrich deleted the docs/add-godoc branch September 2, 2025 17:15
@github-actions
Copy link
Copy Markdown

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants