Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issues for samples without tutorials/documentation #729

Closed
23 tasks
SaschaWillems opened this issue Jun 26, 2023 · 2 comments
Closed
23 tasks

Tracking issues for samples without tutorials/documentation #729

SaschaWillems opened this issue Jun 26, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@SaschaWillems
Copy link
Collaborator

Esp. older samples don't have proper tutorials/documentation and only contain a readme stub.

Since we want to make the documentation of this repo part of the broader Vulkan docs, we should add proper tutorials/documentation for all samples.

This is a tracker issue for that, here is the list of tutorials that don't have a proper tutorial/readme:

  • api/compute_nbody
  • api/hpp_compute_nbody
  • api/dynamic_uniform_buffers
  • api/hpp_dynamic_uniform_buffers
  • api/hdr
  • api/hpp_hdr
  • api/hello_triangle
  • api/hpp_hello_triangle
  • api/instancing
  • api/hpp_instancing
  • api/terrain_tessellation
  • api/hpp_terrain_tessellation
  • api/texture_loading
  • api/hpp_texture_loading
  • extensions/conservative_rasterization
  • extensions/fragment_shading_rate
  • extensions/mesh_shading
  • extensions/open_gl_interop
  • extensions/push_descriptors
  • extensions/raytracing_basic
  • extensions/ray_queries
  • extensions/synchronization_2
  • performance/texture_compression_comparison

This is related to #693

@SaschaWillems SaschaWillems added the documentation Improvements or additions to documentation label Jun 26, 2023
@tomadamatkinson
Copy link
Collaborator

We may want to comment up the hello triangle code base with links to the Vulkan Tutorial documentation. It may make it easier if a reader can jump from function X to a specific part of the documentation

@SaschaWillems
Copy link
Collaborator Author

We agreed that this has very little priority, esp. when compared to the effort, so closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants