Fixed all issues with the tutorial after following it again

Author: GabeRundlett

docs/01_Installing_dependencies.md

@@ -6,7 +6,7 @@ This page will explain how to install all the necessary tools to compile the Dax
 
 ### Visual Studio
 
-In this tutorial, ~~we will be using Clang as our compiler~~ (EDIT: For now, there are some issues with Clang on Windows, so ). Clang relies on the Microsoft STL, which we can get most easily by installing [Visual Studio](https://visualstudio.microsoft.com/de/vs/community/) and selecting the C++ desktop development component during installation
+In this tutorial, ~~we will be using Clang as our compiler~~ (EDIT: For now, there are some issues with Clang on Windows, so we'll just use the Visual Studio compiler for now). Clang relies on the Microsoft STL, which we can get most easily by installing [Visual Studio](https://visualstudio.microsoft.com/de/vs/community/) and selecting the C++ desktop development component during installation
 
 ### Clang & Ninja
 

docs/03_Getting_started/00_Creating_a_window.md

@@ -25,7 +25,7 @@ using namespace daxa::types;
 #define GLFW_EXPOSE_NATIVE_WIN32
 #define GLFW_NATIVE_INCLUDE_NONE
 using HWND = void *;
-#elif defined(__linux__)/
+#elif defined(__linux__)
 #define GLFW_EXPOSE_NATIVE_X11
 #define GLFW_EXPOSE_NATIVE_WAYLAND
 #endif

docs/03_Getting_started/07_Task_graph.md

@@ -1,6 +1,6 @@
 ## Description
 
-While not entirely necessary, we're going to use TaskGraph, which allows us to compile a list of GPU tasks and their dependencies into a synchronized set of commands. This simplifies your code by making different tasks completely self-contained, while also generating the most optimal synchronization for the tasks you describe.
+While not entirely necessary, we're going to use TaskGraph, which allows us to compile a list of GPU tasks and their dependencies into a synchronized set of commands. This simplifies your code by making different tasks completely self-contained, while also generating the most optimal synchronization for the tasks you describe. To use TaskGraph, as its also an optional feature, add the include path `<daxa/utils/task_graph.hpp>` at the top of our main file.
 
 ## Creating a vertex uploading task
 
@@ -19,7 +19,7 @@ void upload_vertex_data_task(daxa::TaskGraph & tg, daxa::TaskBufferView vertices
         },
         .task = [=](daxa::TaskInterface ti)
         {
-            // ...
+            // [...]
         },
     });
 }
@@ -148,16 +148,10 @@ loop_task_graph.use_persistent_buffer(task_vertex_buffer);
 loop_task_graph.use_persistent_image(task_swapchain_image);
 ```
 
-Since we need the task graph to do something, we add a task that draws to the screen:
+Since we need the task graph to do something, we add the task that draws to the screen:
 
 ```cpp
-loop_task_graph.add_task(DrawToSwapchainTask{
-    .uses = {
-        .vertex_buffer = task_vertex_buffer.view(),
-        .color_target = task_swapchain_image.view(),
-    },
-    .pipeline = pipeline.get(),
-});
+draw_vertices_task(loop_task_graph, pipeline, task_vertex_buffer, task_swapchain_image);
 ```
 
 Once we have added all the tasks we want, we have to tell the task graph we are done.

docs/03_Getting_started/08_Shader.md

@@ -37,6 +37,9 @@ layout(location = 0) out daxa_f32vec4 color;
 void main()
 {
     color = daxa_f32vec4(v_col, 1);
+
+    // Debug printf is not necessary, we just use it here to show how it can be used.
+    // To be able to see the debug printf output, you need to open Vulkan Configurator and enable it there.
     debugPrintfEXT("test\n");
 }
 

docs/03_Getting_started/09_Finishing_up.md

@@ -374,11 +374,19 @@ struct MyPushConstant
 ```cpp
 // src/shaders/main.glsl
 
+// Includes the daxa shader API
 #include <daxa/daxa.inl>
+
+// Enabled the extension GL_EXT_debug_printf
+#extension GL_EXT_debug_printf : enable
+
+// Includes our shared types we created earlier
 #include <shared.inl>
 
+// Enabled the push constant MyPushConstant we specified in shared.inl
 DAXA_DECL_PUSH_CONSTANT(MyPushConstant, push)
 
+// We can define the vertex & fragment shader in one single file
 #if DAXA_SHADER_STAGE == DAXA_SHADER_STAGE_VERTEX
 
 layout(location = 0) out daxa_f32vec3 v_col;
@@ -396,6 +404,9 @@ layout(location = 0) out daxa_f32vec4 color;
 void main()
 {
     color = daxa_f32vec4(v_col, 1);
+
+    // Debug printf is not necessary, we just use it here to show how it can be used.
+    // To be able to see the debug printf output, you need to open Vulkan Configurator and enable it there.
     debugPrintfEXT("test\n");
 }