Skip to content

Documentation clarity for beginners #421

@JHops881

Description

@JHops881

As a beginner to Vulkan, I was recommended to use this library. As a library created for accessibility to Vulkan, I think it is falling short in providing the jumpstart it promises especially in accessibility to new Vulkan learners.

For context, I am following along to the tutorial at https://docs.vulkan.org/tutorial/latest/00_Introduction.html
I would expect the docs for vk-bootstrap to follow a similar structure, yet it seems they fall short on providing some key details.

one particular example is that the language currently located at
Currently under WSI -> Surface Creation
"However, vk-bootstrap does try to make the process as painless as possible by automatically enabling the correct windowing extensions in VkInstance creation."

Is not immediately obvious when reading the section on Instance Creation, which led to a lot of confusion--ultimately wasting time that vk-bootstrap aims to eliminate. I suggest having this information in both locations and re-evaluating the documentation for ambiguity and missed details that are not immediately obvious to someone new to Vulkan.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions