Skip to content
This repository was archived by the owner on Aug 2, 2025. It is now read-only.

Commit 070c978

Browse files
FabulousCodingFoxFabulousCodingFox
committed
Migrated to starlight
1 parent 2b19033 commit 070c978

14 files changed

+130
-45
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy to tutorial.learndaxa.com
1+
name: Deploy to tutorial.daxa.dev
22
on:
33
push:
44
branches: ["main"]
@@ -20,47 +20,42 @@ jobs:
2020
url: ${{ steps.deployment.outputs.page_url }}
2121
runs-on: ubuntu-latest
2222
steps:
23-
- name: Checkout
24-
uses: actions/checkout@v3
25-
26-
- name: Setup Node.js
27-
uses: actions/setup-node@v2
28-
with:
29-
node-version: "20"
30-
31-
- name: Setup Python
32-
uses: actions/setup-python@v2
33-
with:
34-
python-version: "3.12"
35-
36-
- name: Clone Repos
37-
run: |
38-
git clone https://${{ secrets.PRIVATE_REPO_ACCESS_TOKEN }}@github.com/learndaxa/WebsiteTemplate.git ../WebsiteTemplate/
39-
git clone https://${{ secrets.PRIVATE_REPO_ACCESS_TOKEN }}@github.com/learndaxa/WebsiteRenderer.git ../WebsiteRenderer/
40-
41-
- name: Install Python dependencies
42-
run: |
43-
pip install -r ../WebsiteRenderer/requirements.txt
44-
45-
- name: Rendering Markdown to Svelte
46-
run: |
47-
python ../WebsiteRenderer/main.py --goal tutorial --source "docs/" --destination "../WebsiteTemplate/src/routes/"
48-
49-
- name: Building Static Site
50-
run: |
51-
cd ../WebsiteTemplate/
52-
npm install
53-
npm run build
54-
55-
- name: Making static links
56-
run: |
57-
cd ../
58-
python WebsiteRenderer/fix.py --destination "WebsiteTemplate/" --domain "https://tutorial.learndaxa.com"
59-
60-
- name: Upload artifact
61-
uses: actions/upload-pages-artifact@v1
62-
with:
63-
path: "../WebsiteTemplate/build/"
64-
- name: Deploy to GitHub Pages
65-
id: deployment
66-
uses: actions/deploy-pages@v1
23+
- name: Checkout
24+
uses: actions/checkout@v3
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v2
28+
with:
29+
node-version: "22"
30+
31+
- name: Clone Starlight Wiki Template
32+
run: |
33+
git clone https://github.com/learndaxa/StarlightWiki.git ../StarlightWiki/
34+
35+
- name: Copy Tutorial Pages
36+
run: |
37+
mkdir -p ../StarlightWiki/src/content/docs/
38+
cp -r ./docs/* ../StarlightWiki/src/content/docs/
39+
40+
- name: 'Create ENV File'
41+
run: |
42+
touch ../StarlightWiki/.env
43+
echo VITE_TITLE="Daxa Tutorial" >> ../StarlightWiki/.env
44+
echo VITE_SITE_URL="https://tutorial.daxa.dev" >> ../StarlightWiki/.env
45+
echo VITE_GITHUB_URL="https://github.com/learndaxa/Tutorial" >> ../StarlightWiki/.env
46+
echo VITE_DISCORD_INVITE="https://discord.gg/mZrUeJfxB8" >> ../StarlightWiki/.env
47+
48+
- name: Building Static Site
49+
run: |
50+
cd ../StarlightWiki/
51+
npm install
52+
npm run astro build
53+
54+
- name: Upload artifact
55+
uses: actions/upload-pages-artifact@v1
56+
with:
57+
path: "../StarlightWiki/dist/"
58+
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v1

‎docs/00 index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Overview
3+
description: The Daxa Tutorial provides an extensive learning resource for the Vulkan abstraction Layer Daxa and is meant as a reference for developers using it.
4+
slug: ""
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/00 index.md
6+
---

docs/01_Installing_dependencies.md renamed to docs/01 Introduction/01_Installing_dependencies.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Installing dependencies
3+
description: Installing dependencies
4+
slug: "introduction/installing-dependencies"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/01 Introduction/01_Installing_dependencies.md
6+
---
7+
18
## Important
29

310
This page will explain how to install all the necessary tools to compile the Daxa repository itself, though these things are also required for consumers of Daxa as a dependency. We'll go over using Daxa as a dependency in the next page. If you have previously worked with Vulkan or C++, you can skip some of these steps. Since those steps are different for Windows and Linux, this page is split into multiple parts. Make sure you follow the steps from the correct heading.

docs/02_Developement_environment.md renamed to docs/01 Introduction/02_Developement_environment.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Developement environment
3+
description: Developement environment
4+
slug: "introduction/developement-environment"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/01 Introduction/02_Developement_environment.md
6+
---
7+
18
## Downloading the starting point
29

310
Download the starting point [here](https://codeload.github.com/learndaxa/daxa-app-template/zip/refs/heads/main) or from its [GitHub](https://github.com/learndaxa/daxa-app-template) and open it with VSCode if prompted select the 'Debug' preset.

docs/03_Getting_started/00_Creating_a_window.md renamed to docs/03 Getting started/00_Creating_a_window.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Creating a window
3+
description: Creating a window
4+
slug: "getting-started/creating-a-window"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/00_Creating_a_window.md
6+
---
7+
18
## Description
29

310
The first thing when developing a graphics application is to open a blank window.

docs/03_Getting_started/01_Creating_an_instance.md renamed to docs/03 Getting started/01_Creating_an_instance.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Creating an instance
3+
description: Creating an instance
4+
slug: "getting-started/creating-an-instance"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/01_Creating_an_instance.md
6+
---
7+
18
## Include the header
29

310
Well done! We have now created all the fundamentals and can finally start using Daxa. To use Daxa's C++ API, we need to include the following header:

docs/03_Getting_started/02_Choosing_a_device.md renamed to docs/03 Getting started/02_Choosing_a_device.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Choosing a device
3+
description: Choosing a device
4+
slug: "getting-started/choosing-a-device"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/02_Choosing_a_device.md
6+
---
7+
18
## Device selection
29

310
A PC can have multiple graphics cards. Unlike OpenGL, you need to manually select which GPU you want to use to perform calculations. Since each GPU is different Daxa provides a simple system to select the GPU best suited for your application. You can choose the considered parameters yourself and change how they are weighed against each other.

docs/03_Getting_started/03_Creating_a_swapchain.md renamed to docs/03 Getting started/03_Creating_a_swapchain.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Creating a swapchain
3+
description: Creating a swapchain
4+
slug: "getting-started/creating-a-swapchain"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/03_Creating_a_swapchain.md
6+
---
7+
18
## Swapchain creation
29

310
In Daxa, the swapchain is a key element in rendering graphics, acting as a bridge between your application and the display. It's a collection of buffers used for displaying images on the screen. Unlike other/older APIs, Vulkan requires explicit management of these, which Daxa luckily handles for you.

docs/03_Getting_started/04_Push_constants.md renamed to docs/03 Getting started/04_Push_constants.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Push constants
3+
description: Push constants
4+
slug: "getting-started/push-constants"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/04_Push_constants.md
6+
---
7+
18
## Description
29

310
The Vulkan spec defines Push Constants as:

docs/03_Getting_started/05_Creating_a_pipeline.md renamed to docs/03 Getting started/05_Creating_a_pipeline.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Creating a pipeline
3+
description: Creating a pipeline
4+
slug: "getting-started/creating-a-pipeline"
5+
editUrl: https://github.com/learndaxa/Tutorial/edit/main/docs/03 Getting started/05_Creating_a_pipeline.md
6+
---
7+
18
## Pipeline manager
29

310
In this tutorial, we will be using the pipeline manager, which is an additional Daxa feature that has to be explicitly imported with the header `<daxa/utils/pipeline_manager.hpp>` and also has to be enabled in our Vcpkg manifest. Both of these steps are already done in the sample code.

0 commit comments

Comments
 (0)