Skip to content

Commit 0c8194a

Browse files
authored
docs: restructure documentation and add comprehensive Luau guides (#58)
- Relocate existing documentation to a nested `/docs/` directory for better organization. - Implement a new "Luau Guides" section covering fundamentals from basic syntax to advanced table usage and modules. - Update VitePress configuration with path-based sidebars for `/docs/` and `/luau-guides/`. - Adjust GitHub release workflow to reflect the new changelog path. - Update homepage (index.md) to feature the new Luau learning resources.
1 parent 643b089 commit 0c8194a

20 files changed

Lines changed: 935 additions & 29 deletions

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
id: changelog
2323
run: |
2424
TAG="${GITHUB_REF_NAME}"
25-
CHANGELOG="docs/blog/changelog.md"
25+
CHANGELOG="docs/docs/blog/changelog.md"
2626
2727
BODY=$(awk "
2828
/^## \`${TAG}\`/ { found=1; next }

docs/.vitepress/config.mjs

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,52 @@ export default defineConfig({
1212
},
1313
nav: [
1414
{ text: 'Home', link: '/' },
15-
{ text: 'Blog', link: '/blog/changelog' }
15+
{ text: 'Blog', link: '/docs/blog/changelog' },
16+
{ text: 'Luau Guides', link: '/luau-guides/introduction' }
1617
],
1718

18-
sidebar: [
19-
{
20-
text: 'Introduction',
21-
items: [
22-
{ text: 'What is Nova?', link: '/introduction/what-is-nova' },
23-
{ text: 'Getting Started', link: '/introduction/getting-started' }
24-
]
25-
},
26-
{
27-
text: 'Guides',
28-
items: [
29-
{ text: 'Project Stucture', link: '/guides/project-structure' },
30-
{ text: 'Routing', link: '/guides/routing' },
31-
{ text: 'Request & Response', link: '/guides/req-res' },
32-
{ text: 'Middlewares', link: '/guides/middleware' }
33-
]
34-
},
35-
{
36-
text: 'Blog',
37-
items: [
38-
{ text: 'Changelog', link: '/blog/changelog' }
39-
]
40-
}
41-
],
19+
sidebar: {
20+
'/docs/': [
21+
{
22+
text: 'Introduction',
23+
items: [
24+
{ text: 'What is Nova?', link: '/docs/introduction/what-is-nova' },
25+
{ text: 'Getting Started', link: '/docs/introduction/getting-started' }
26+
]
27+
},
28+
{
29+
text: 'Guides',
30+
items: [
31+
{ text: 'Project Stucture', link: '/docs/guides/project-structure' },
32+
{ text: 'Routing', link: '/docs/guides/routing' },
33+
{ text: 'Request & Response', link: '/docs/guides/req-res' },
34+
{ text: 'Middlewares', link: '/docs/guides/middleware' }
35+
]
36+
},
37+
{
38+
text: 'Blog',
39+
items: [
40+
{ text: 'Changelog', link: '/docs/blog/changelog' }
41+
]
42+
}
43+
],
44+
'/luau-guides/': [
45+
{
46+
text: 'The Basics of Luau',
47+
items: [
48+
{ text: 'Introduction', link: '/luau-guides/introduction' },
49+
{ text: 'Your First Program', link: '/luau-guides/your-first-program' },
50+
{ text: 'Variables & Data Types', link: '/luau-guides/vars-and-datatypes' },
51+
{ text: 'Basic Math & Logic', link: '/luau-guides/basic-math-and-logic' },
52+
{ text: 'The Luau Upgrades', link: '/luau-guides/the-luau-upgrades' },
53+
{ text: 'Condition Flow', link: '/luau-guides/condition-flow' },
54+
{ text: 'Loops', link: '/luau-guides/loops' },
55+
{ text: 'Functions', link: '/luau-guides/functions' },
56+
{ text: 'Tables', link: '/luau-guides/tables' },
57+
]
58+
}
59+
]
60+
},
4261

4362
socialLinks: [
4463
{ icon: 'github', link: 'https://github.com/nova-guild/nova' }
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)