From 832e9644ee90ec64fa5887ee24db4ab5e4cc1447 Mon Sep 17 00:00:00 2001 From: Skullian <133133667+Skullians@users.noreply.github.com> Date: Wed, 9 Oct 2024 18:35:56 +0100 Subject: [PATCH] file name adjustments --- docs/.vitepress/config.mts | 20 ++++++++++++------- docs/about_us.md | 6 ++++-- docs/index.md | 2 +- .../guis/{README.md => overview.md} | 0 .../configuration/{README.md => overview.md} | 0 .../installation/{README.md => overview.md} | 0 .../setup/{README.md => overview.md} | 0 docs/skyfactions/mechanics/factions/README.md | 9 --------- .../mechanics/factions/factions-overview.md | 9 +++++++++ .../mechanics/factions/overview.md | 10 +++++----- .../mechanics/{README.md => overview.md} | 0 docs/skyfactions/{README.md => overview.md} | 0 12 files changed, 32 insertions(+), 24 deletions(-) rename docs/skyfactions/installation/configuration/guis/{README.md => overview.md} (100%) rename docs/skyfactions/installation/configuration/{README.md => overview.md} (100%) rename docs/skyfactions/installation/{README.md => overview.md} (100%) rename docs/skyfactions/installation/setup/{README.md => overview.md} (100%) delete mode 100644 docs/skyfactions/mechanics/factions/README.md create mode 100644 docs/skyfactions/mechanics/factions/factions-overview.md rename docs/skyfactions/mechanics/{README.md => overview.md} (100%) rename docs/skyfactions/{README.md => overview.md} (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 17ade53..7e025c9 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -9,23 +9,29 @@ export default defineConfig({ logo: "/assets/TBLogo.png", nav: [ { text: 'Home', link: '/' }, - { text: 'SkyFactionsReborn', link: '/skyfactions/README' }, + { text: 'SkyFactionsReborn', link: '/skyfactions/overview' }, { text: 'About Us', link: '/about_us'} ], sidebar: [ + { + text: "TerraByteDev", + items: [ + { text: "Who We Are", link: "/about_us"} + ] + }, { text: 'SkyFactions', items: [ - { text: 'Overview', link: '/skyfactions/README' }, + { text: 'Overview', link: '/skyfactions/overview' }, { text: "Installation", - link: "/skyfactions/installation/README", + link: "/skyfactions/installation/overview", collapsed: true, items: [ { text: "Setup", - link: "/skyfactions/installation/setup/README", + link: "/skyfactions/installation/setup/overview", collapsed: true, items: [ { text: "Database Setup", link: "/skyfactions/installation/setup/database-setup"}, @@ -41,7 +47,7 @@ export default defineConfig({ }, { text: "Mechanics", - link: "/skyfactions/mechanics/README", + link: "/skyfactions/mechanics/overview", collapsed: true, items: [ { text: "Islands", link: "/skyfactions/mechanics/islands"}, @@ -49,10 +55,10 @@ export default defineConfig({ { text: "Runes", link: "/skyfactions/mechanics/runes"}, { text: "Factions", - link: "/skyfactions/mechanics/factions/README", + link: "/skyfactions/mechanics/factions/overview", collapsed: true, items: [ - { text: "Overview", link: "/skyfactions/mechanics/factions/overview"}, + { text: "Overview", link: "/skyfactions/mechanics/factions/factions-overview"}, { text: "Faction Ranks & Titles", link: "/skyfactions/mechanics/factions/faction-ranks-titles"} ] } diff --git a/docs/about_us.md b/docs/about_us.md index 7982caf..5534a29 100644 --- a/docs/about_us.md +++ b/docs/about_us.md @@ -1,7 +1,9 @@ -# About Us +# Who We Are Hey, we're TerraByteDev! We're a small, passionate development studio dedicated towards crafting innovative plugins and tools for the public. We stride towards innovation and aim to bring creative solutions to the community. -We are committed to building high-quality plugins and tools that empower users, enhance productivity and push the boundaries of what is possible. \ No newline at end of file +We are committed to building high-quality plugins and tools that empower users, enhance productivity and push the boundaries of what is possible. + +Come join us on our [Discord](https://discord.gg/SwxXMrFdjp)! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 60fa141..d0424d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ hero: actions: - theme: brand text: SkyFactions Docs - link: /skyfactions/README + link: /skyfactions/overview - theme: alt text: About Us link: /about_us diff --git a/docs/skyfactions/installation/configuration/guis/README.md b/docs/skyfactions/installation/configuration/guis/overview.md similarity index 100% rename from docs/skyfactions/installation/configuration/guis/README.md rename to docs/skyfactions/installation/configuration/guis/overview.md diff --git a/docs/skyfactions/installation/configuration/README.md b/docs/skyfactions/installation/configuration/overview.md similarity index 100% rename from docs/skyfactions/installation/configuration/README.md rename to docs/skyfactions/installation/configuration/overview.md diff --git a/docs/skyfactions/installation/README.md b/docs/skyfactions/installation/overview.md similarity index 100% rename from docs/skyfactions/installation/README.md rename to docs/skyfactions/installation/overview.md diff --git a/docs/skyfactions/installation/setup/README.md b/docs/skyfactions/installation/setup/overview.md similarity index 100% rename from docs/skyfactions/installation/setup/README.md rename to docs/skyfactions/installation/setup/overview.md diff --git a/docs/skyfactions/mechanics/factions/README.md b/docs/skyfactions/mechanics/factions/README.md deleted file mode 100644 index b10caaa..0000000 --- a/docs/skyfactions/mechanics/factions/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: Guide through the Factions. ---- - -# Factions - -Factions is one of the key principles of the gameplay SkyFactions provides, and therefore has many features.\ -\ -See the following sub-pages for further information. diff --git a/docs/skyfactions/mechanics/factions/factions-overview.md b/docs/skyfactions/mechanics/factions/factions-overview.md new file mode 100644 index 0000000..64ecd8f --- /dev/null +++ b/docs/skyfactions/mechanics/factions/factions-overview.md @@ -0,0 +1,9 @@ +--- +description: Information concerning the Factions mechanic. +--- + +# Factions Overview +Factions is one of the most important features of SkyFactions. +It allows multiple individuals to group together and start another island (on top of their private, individual islands), raid other Factions and more. + +By default, it costs **100 Runes** to create a Faction, which is configurable in the `config.yml`. \ No newline at end of file diff --git a/docs/skyfactions/mechanics/factions/overview.md b/docs/skyfactions/mechanics/factions/overview.md index 64ecd8f..b10caaa 100644 --- a/docs/skyfactions/mechanics/factions/overview.md +++ b/docs/skyfactions/mechanics/factions/overview.md @@ -1,9 +1,9 @@ --- -description: Information concerning the Factions mechanic. +description: Guide through the Factions. --- -# Factions Overview -Factions is one of the most important features of SkyFactions. -It allows multiple individuals to group together and start another island (on top of their private, individual islands), raid other Factions and more. +# Factions -By default, it costs **100 Runes** to create a Faction, which is configurable in the `config.yml`. \ No newline at end of file +Factions is one of the key principles of the gameplay SkyFactions provides, and therefore has many features.\ +\ +See the following sub-pages for further information. diff --git a/docs/skyfactions/mechanics/README.md b/docs/skyfactions/mechanics/overview.md similarity index 100% rename from docs/skyfactions/mechanics/README.md rename to docs/skyfactions/mechanics/overview.md diff --git a/docs/skyfactions/README.md b/docs/skyfactions/overview.md similarity index 100% rename from docs/skyfactions/README.md rename to docs/skyfactions/overview.md