Skip to content

Commit 72a3c01

Browse files
committed
Some content tweaks
- Split out pages into flywheel and vanillin trees - Migrate existing "docs" into the site
1 parent 10bd202 commit 72a3c01

17 files changed

Lines changed: 145 additions & 49 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
// noinspection JSUnusedGlobalSymbols
22

33
import { defineConfig } from "vitepress";
4-
import tutorial from "./sidebars/tutorial";
5-
import developers from "./sidebars/developers";
64

75
// https://vitepress.dev/reference/site-config
86
export default defineConfig({
9-
title: "Flywheel Docs",
10-
description: "A modern engine for modded Minecraft.",
7+
title: "Engine-Room",
8+
description: "Graphics tech for Minecraft.",
119

1210
cleanUrls: true,
1311
lastUpdated: true,
@@ -27,11 +25,49 @@ export default defineConfig({
2725
},
2826

2927
// https://vitepress.dev/reference/default-theme-config
30-
nav: [{ text: "Home", link: "/" }],
28+
nav: [
29+
{
30+
text: "Home",
31+
link: "/",
32+
},
33+
{
34+
text: 'Flywheel',
35+
link: '/flywheel/',
36+
activeMatch: '/flywheel/',
37+
},
38+
{
39+
text: 'Vanillin',
40+
link: '/vanillin/',
41+
activeMatch: '/vanillin/',
42+
},
43+
],
3144

3245
sidebar: {
33-
...developers,
34-
...tutorial,
46+
"/flywheel/api": [
47+
{
48+
text: "Flywheel API",
49+
items: [
50+
{ text: "Index", link: "/flywheel/api" },
51+
{ text: "GLSL API", link: "/flywheel/api/glsl-api" },
52+
]
53+
},
54+
],
55+
"/flywheel/tutorial": [
56+
{
57+
text: "Flywheel Tutorial",
58+
items: [
59+
{ text: "Index", link: "/flywheel/tutorial" },
60+
]
61+
},
62+
],
63+
"/vanillin/": [
64+
{
65+
text: "Vanillin",
66+
items: [
67+
{ text: "Settings", link: "/vanillin/settings" },
68+
]
69+
}
70+
]
3571
},
3672

3773
socialLinks: [
@@ -43,7 +79,8 @@ export default defineConfig({
4379
],
4480

4581
editLink: {
46-
pattern: "https://github.com/Engine-Room/Flywheel/edit/main/docs/:path",
82+
// Can we get this to automatically pick the main branch?
83+
pattern: "https://github.com/Engine-Room/Flywheel/edit/1.20.1/dev/docs/:path",
4784
text: "Edit this page on GitHub",
4885
},
4986
},

docs/.vitepress/sidebars/developers.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/.vitepress/sidebars/tutorial.ts

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/examples/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/examples/no_instancing/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/examples/no_instancing/data/vanillin/tags/items/no_instancing.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/flywheel/api/glsl-api.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
# GLSL API
4+
5+
Flywheel backends expect user-authored shaders to follow a specific format.
6+
7+
## Prelude
8+
9+
The Prelude is included by default for all shaders compiled by Flywheel backends.
10+
11+
Some functions/variables are only available for specific shader stages.
12+
13+
::: code-group
14+
15+
<<< snippets/common.glsl
16+
<<< snippets/material.glsl
17+
<<< snippets/vertex.glsl
18+
<<< snippets/fragment.glsl
19+
20+
:::
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
title: API Docs
32
description: Documentation related to Flywheel's API.
43

54
next: false

0 commit comments

Comments
 (0)