Skip to content

Adjust documentation of first three chapters to the corresponding sources.#289

Merged
SaschaWillems merged 2 commits intoKhronosGroup:mainfrom
asuessenbach:docu
Feb 17, 2026
Merged

Adjust documentation of first three chapters to the corresponding sources.#289
SaschaWillems merged 2 commits intoKhronosGroup:mainfrom
asuessenbach:docu

Conversation

@asuessenbach
Copy link
Contributor

The adjustments in 02_validation_layers.adoc required some changes in 02_validation_layers.cpp.

As usual, if those changes are considered to be ok, I can carry them over to all the other chapters.

@asuessenbach
Copy link
Contributor Author

Any opinions?

@SaschaWillems
Copy link
Collaborator

Can you elaborate a bit? This looks like a pretty substantial change.

@asuessenbach
Copy link
Contributor Author

Can you elaborate a bit? This looks like a pretty substantial change.

Essentially, I replaced all occurances of C-style vulkan terminology to C++-style in 00_Base_code.adoc, 01_Instance.adoc, and 02_Validation_layers.adoc.
While doing that, I adjusted the documentation to the actual code in the corresponding code files 00_base_code.cpp, 01_instance_creation.cpp, and 02_validation_layers.cpp.
While doing that, I realized that parts of the documentation in 02_Validation_layers.adoc where "better" than the documented code, so I adjusted those parts in 02_validation_layers.cpp accordingly.

If there are any parts in this PR that needs more explanation, please let me know.

@SaschaWillems
Copy link
Collaborator

Thanks for explaining :)

I'm fine with these, so feel free to apply this to the other chapters.

@asuessenbach
Copy link
Contributor Author

What would I have to do to get this reviewed again and merged?

Copy link
Collaborator

@SaschaWillems SaschaWillems left a comment

Choose a reason for hiding this comment

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

LGTM.

Tested most of the chapters and everything worked as expected.

@SaschaWillems
Copy link
Collaborator

As Steve also approved, I'll merge now.

@SaschaWillems SaschaWillems merged commit e9054a2 into KhronosGroup:main Feb 17, 2026
6 checks passed
@asuessenbach asuessenbach deleted the docu branch February 18, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments