From 64c928e2694fccfd8d9bc31df8c80fa4a85ff2ac Mon Sep 17 00:00:00 2001 From: James Date: Mon, 25 Sep 2023 07:12:16 -0500 Subject: [PATCH] fix doc issue --- docs/.vitepress/config.mts | 44 +++++++++--------- docs/{GetStarted => start}/comparison.md | 0 docs/{GetStarted => start}/faq.md | 0 docs/{GetStarted => start}/features.md | 0 docs/{GetStarted => start}/installation.md | 0 docs/{GetStarted => start}/intro.md | 0 docs/{Tutorials => tutorial}/customloader.md | 0 docs/{Tutorials => tutorial}/datastoring.md | 0 .../explorer-properties.png | Bin .../explorer-selection.png | Bin .../datastoring-images/playerlist-example.png | Bin .../structure-images/default-explorer.png | Bin .../images/update-images/error-example.png | Bin .../images/update-images/where-to-update.png | Bin .../libraries/benchmark.md | 0 .../libraries/debugger.md | 0 .../libraries/uishelf.md | 0 docs/{Tutorials => tutorial}/networking.md | 0 docs/{Tutorials => tutorial}/packages.md | 0 docs/{Tutorials => tutorial}/signals.md | 0 docs/{Tutorials => tutorial}/structure.md | 0 docs/{Tutorials => tutorial}/styleguide.md | 0 docs/{Tutorials => tutorial}/update.md | 0 23 files changed, 22 insertions(+), 22 deletions(-) rename docs/{GetStarted => start}/comparison.md (100%) rename docs/{GetStarted => start}/faq.md (100%) rename docs/{GetStarted => start}/features.md (100%) rename docs/{GetStarted => start}/installation.md (100%) rename docs/{GetStarted => start}/intro.md (100%) rename docs/{Tutorials => tutorial}/customloader.md (100%) rename docs/{Tutorials => tutorial}/datastoring.md (100%) rename docs/{Tutorials => tutorial}/images/customloader-images/explorer-properties.png (100%) rename docs/{Tutorials => tutorial}/images/customloader-images/explorer-selection.png (100%) rename docs/{Tutorials => tutorial}/images/datastoring-images/playerlist-example.png (100%) rename docs/{Tutorials => tutorial}/images/structure-images/default-explorer.png (100%) rename docs/{Tutorials => tutorial}/images/update-images/error-example.png (100%) rename docs/{Tutorials => tutorial}/images/update-images/where-to-update.png (100%) rename docs/{Tutorials => tutorial}/libraries/benchmark.md (100%) rename docs/{Tutorials => tutorial}/libraries/debugger.md (100%) rename docs/{Tutorials => tutorial}/libraries/uishelf.md (100%) rename docs/{Tutorials => tutorial}/networking.md (100%) rename docs/{Tutorials => tutorial}/packages.md (100%) rename docs/{Tutorials => tutorial}/signals.md (100%) rename docs/{Tutorials => tutorial}/structure.md (100%) rename docs/{Tutorials => tutorial}/styleguide.md (100%) rename docs/{Tutorials => tutorial}/update.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 507d0bdc..d704e787 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -14,9 +14,9 @@ export default defineConfig({ { text: 'Guides', items: [ - { text: 'Get Started', link: '/getstarted/intro'}, - { text: 'Usage', link: '/tutorials/update' }, - { text: 'Libraries', link: '/tutorials/libraries/benchmark' } + { text: 'Get Started', link: '/start/intro'}, + { text: 'Usage', link: '/tutorial/update' }, + { text: 'Libraries', link: '/tutorial/libraries/benchmark' } ] }, @@ -41,46 +41,46 @@ export default defineConfig({ ], sidebar: { - '/tutorials/libraries/': [ + '/tutorial/libraries/': [ { text: 'Libraries', items: [ - { text: 'Benchmark', link: '/tutorials/libraries/benchmark' }, - { text: 'Debugger', link: '/tutorials/libraries/debugger' }, - { text: 'UIShelf', link: '/tutorials/libraries/uishelf' } + { text: 'Benchmark', link: '/tutorial/libraries/benchmark' }, + { text: 'Debugger', link: '/tutorial/libraries/debugger' }, + { text: 'UIShelf', link: '/tutorial/libraries/uishelf' } ] } ], - '/getstarted': [ + '/start': [ { text: 'Get Started', items: [ - { text: 'Introduction', link: '/getstarted/intro' }, - { text: 'Features', link: '/getstarted/features' }, - { text: 'Comparison', link: '/getstarted/comparison' }, - { text: 'Installation', link: '/getstarted/installation' }, - { text: 'FAQ', link: '/getstarted/faq' } + { text: 'Introduction', link: '/start/intro' }, + { text: 'Features', link: '/start/features' }, + { text: 'Comparison', link: '/start/comparison' }, + { text: 'Installation', link: '/start/installation' }, + { text: 'FAQ', link: '/start/faq' } ] } ], - '/tutorials': [ + '/tutorial': [ { text: 'Management', items: [ - { text: 'Update', link: '/tutorials/update' }, - { text: 'Packages', link: '/tutorials/packages' }, - { text: 'Structure', link: '/tutorials/structure' }, - { text: 'Style Guide', link: '/tutorials/styleguide' }, + { text: 'Update', link: '/tutorial/update' }, + { text: 'Packages', link: '/tutorial/packages' }, + { text: 'Structure', link: '/tutorial/structure' }, + { text: 'Style Guide', link: '/tutorial/styleguide' }, ] }, { text: 'Engine', items: [ - { text: 'Signals', link: 'tutorials/signals' }, - { text: 'Networking', link: 'tutorials/networking' }, - { text: 'Data Management', link: 'tutorials/datastoring' }, - { text: 'Loading Screen', link: 'tutorials/customloader' } + { text: 'Signals', link: 'tutorial/signals' }, + { text: 'Networking', link: 'tutorial/networking' }, + { text: 'Data Management', link: 'tutorial/datastoring' }, + { text: 'Loading Screen', link: 'tutorial/customloader' } ] } ], diff --git a/docs/GetStarted/comparison.md b/docs/start/comparison.md similarity index 100% rename from docs/GetStarted/comparison.md rename to docs/start/comparison.md diff --git a/docs/GetStarted/faq.md b/docs/start/faq.md similarity index 100% rename from docs/GetStarted/faq.md rename to docs/start/faq.md diff --git a/docs/GetStarted/features.md b/docs/start/features.md similarity index 100% rename from docs/GetStarted/features.md rename to docs/start/features.md diff --git a/docs/GetStarted/installation.md b/docs/start/installation.md similarity index 100% rename from docs/GetStarted/installation.md rename to docs/start/installation.md diff --git a/docs/GetStarted/intro.md b/docs/start/intro.md similarity index 100% rename from docs/GetStarted/intro.md rename to docs/start/intro.md diff --git a/docs/Tutorials/customloader.md b/docs/tutorial/customloader.md similarity index 100% rename from docs/Tutorials/customloader.md rename to docs/tutorial/customloader.md diff --git a/docs/Tutorials/datastoring.md b/docs/tutorial/datastoring.md similarity index 100% rename from docs/Tutorials/datastoring.md rename to docs/tutorial/datastoring.md diff --git a/docs/Tutorials/images/customloader-images/explorer-properties.png b/docs/tutorial/images/customloader-images/explorer-properties.png similarity index 100% rename from docs/Tutorials/images/customloader-images/explorer-properties.png rename to docs/tutorial/images/customloader-images/explorer-properties.png diff --git a/docs/Tutorials/images/customloader-images/explorer-selection.png b/docs/tutorial/images/customloader-images/explorer-selection.png similarity index 100% rename from docs/Tutorials/images/customloader-images/explorer-selection.png rename to docs/tutorial/images/customloader-images/explorer-selection.png diff --git a/docs/Tutorials/images/datastoring-images/playerlist-example.png b/docs/tutorial/images/datastoring-images/playerlist-example.png similarity index 100% rename from docs/Tutorials/images/datastoring-images/playerlist-example.png rename to docs/tutorial/images/datastoring-images/playerlist-example.png diff --git a/docs/Tutorials/images/structure-images/default-explorer.png b/docs/tutorial/images/structure-images/default-explorer.png similarity index 100% rename from docs/Tutorials/images/structure-images/default-explorer.png rename to docs/tutorial/images/structure-images/default-explorer.png diff --git a/docs/Tutorials/images/update-images/error-example.png b/docs/tutorial/images/update-images/error-example.png similarity index 100% rename from docs/Tutorials/images/update-images/error-example.png rename to docs/tutorial/images/update-images/error-example.png diff --git a/docs/Tutorials/images/update-images/where-to-update.png b/docs/tutorial/images/update-images/where-to-update.png similarity index 100% rename from docs/Tutorials/images/update-images/where-to-update.png rename to docs/tutorial/images/update-images/where-to-update.png diff --git a/docs/Tutorials/libraries/benchmark.md b/docs/tutorial/libraries/benchmark.md similarity index 100% rename from docs/Tutorials/libraries/benchmark.md rename to docs/tutorial/libraries/benchmark.md diff --git a/docs/Tutorials/libraries/debugger.md b/docs/tutorial/libraries/debugger.md similarity index 100% rename from docs/Tutorials/libraries/debugger.md rename to docs/tutorial/libraries/debugger.md diff --git a/docs/Tutorials/libraries/uishelf.md b/docs/tutorial/libraries/uishelf.md similarity index 100% rename from docs/Tutorials/libraries/uishelf.md rename to docs/tutorial/libraries/uishelf.md diff --git a/docs/Tutorials/networking.md b/docs/tutorial/networking.md similarity index 100% rename from docs/Tutorials/networking.md rename to docs/tutorial/networking.md diff --git a/docs/Tutorials/packages.md b/docs/tutorial/packages.md similarity index 100% rename from docs/Tutorials/packages.md rename to docs/tutorial/packages.md diff --git a/docs/Tutorials/signals.md b/docs/tutorial/signals.md similarity index 100% rename from docs/Tutorials/signals.md rename to docs/tutorial/signals.md diff --git a/docs/Tutorials/structure.md b/docs/tutorial/structure.md similarity index 100% rename from docs/Tutorials/structure.md rename to docs/tutorial/structure.md diff --git a/docs/Tutorials/styleguide.md b/docs/tutorial/styleguide.md similarity index 100% rename from docs/Tutorials/styleguide.md rename to docs/tutorial/styleguide.md diff --git a/docs/Tutorials/update.md b/docs/tutorial/update.md similarity index 100% rename from docs/Tutorials/update.md rename to docs/tutorial/update.md