Skip to content

docs: replace "link:" with "xref:" for internal page references #397

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.

Sign up for GitHub

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

Open
Floriansylvain wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: replace "link:" with "xref:" for internal page references #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/08_Loading_models.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We _will_ load mesh data from an OBJ model in this chapter, but we'll focus more

We will use the https://github.com/syoyo/tinyobjloader[tinyobjloader] library to load vertices and faces from an OBJ file.
It's fast and it's easy to integrate because it's a single file library like stb_image.
This was mentioned in the link:02_Development_environment.adoc[Development Environment] chapter and should be part of the dependencies for this portion of the tutorial.
This was mentioned in the xref:02_Development_environment.adoc[Development Environment] chapter and should be part of the dependencies for this portion of the tutorial.

== Sample mesh

Expand Down
2 changes: 1 addition & 1 deletion en/18_Ray_tracing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
== SIGGRAPH 2025: Hands-on Vulkan Ray Tracing with Dynamic Rendering

Find the course link:courses/18_Ray_tracing/00_Overview.adoc[here]
Find the course xref:courses/18_Ray_tracing/00_Overview.adoc[here]
4 changes: 2 additions & 2 deletions en/conclusion.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Throughout this tutorial series, you've gained knowledge and practical experienc
This tutorial series has provided you with the essential tools for more
advanced Vulkan development. With these fundamentals mastered, you're now ready to explore more complex topics and build more sophisticated applications.

1. link:Building_a_Simple_Engine/introduction.adoc[*Building a Simple Game Engine*] - Ready to take your Vulkan skills to the next level?
1. xref:Building_a_Simple_Engine/introduction.adoc[*Building a Simple Game Engine*] - Ready to take your Vulkan skills to the next level?
This tutorial series will teach you how to structure your Vulkan code into a reusable and maintainable engine architecture.
You'll learn engine architecture and design patterns, scene management with hierarchical object systems, camera systems and controls, efficient resource and memory management, Entity Component System (ECS) patterns, render system abstraction, input handling, and robust game loop design with proper timing.
The series also covers essential math and rendering concepts needed for advanced techniques like Forward+ rendering with tiled lighting, shadow mapping techniques, HRTF spatial audio integration, GPU-accelerated physics simulation using compute shaders, and Ray Query for hybrid rendering effects.
Expand Down Expand Up @@ -71,4 +71,4 @@ Don't hesitate to reach out to these communities - they're filled with developer
Thank you for following along with this tutorial series. You've taken a big
first step in a long journey.

link:17_Multithreading.adoc[Previous: Multithreading] | link:Building_a_Simple_Engine/introduction.adoc[Next: Building a Simple Engine]
xref:17_Multithreading.adoc[Previous: Multithreading] | xref:Building_a_Simple_Engine/introduction.adoc[Next: Building a Simple Engine]
2 changes: 1 addition & 1 deletion en/courses/18_Ray_tracing/01_Dynamic_rendering.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ vk::RenderingInfo renderingInfo = {
commandBuffers[frameIndex].beginRendering(renderingInfo);
----

For more context, refer to the previous tutorial link:../../03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.adoc[chapter].
For more context, refer to the previous tutorial xref:../../03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.adoc[chapter].

=== Dynamic rendering with RenderDoc

Expand Down