Skip to content

Commit 29eba9b

Browse files
committed
a lot of structure related changes and basics
1 parent e82d66c commit 29eba9b

File tree

14 files changed

+113
-65
lines changed

14 files changed

+113
-65
lines changed

docs/.vitepress/config.mts

Lines changed: 79 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,52 @@
11
import {DefaultTheme, defineConfig } from 'vitepress'
22

33
export default defineConfig({
4-
title: "Rusherhack Docs",
5-
base: "/documentation",
6-
description: "Indepth docs for rusherhacks plugins",
4+
title: "RusherHack Documentation",
5+
base: "",
6+
head: [
7+
['link', { rel: 'icon', href: './assets/rh-head_256x256.png' }]
8+
],
9+
description: "Documentation for all things related to RusherHack.",
710
themeConfig: {
8-
logo: 'assets/rusherhack-logo-head.png',
11+
logo: 'assets/rh-head_256x256.png',
912
search: {
1013
provider: 'local'
1114
},
1215
nav: [
13-
{ text: 'Basics', link: '/basics/' },
14-
{ text: 'Client', link: '/client/' },
16+
{ text: 'Guide', link: '/guide/' },
17+
{ text: 'Features', link: '/features/' },
1518
{ text: 'API', link: '/api/' },
1619
],
1720
sidebar: {
1821
'/': { base: '/', items: sidebarBase() },
19-
'/basics/': { base: '/basics/', items: sidebarBasics() },
20-
'/client/': { base: '/client/', items: sidebarClient() },
22+
'/guide/': { base: '/guide/', items: sidebarGuide() },
23+
'/features/': { base: '/features/', items: sidebarFeatures() },
2124
'/api/': { base: '/api/', items: sidebarAPI() },
2225
},
2326
socialLinks: [
24-
{ icon: 'github', link: 'https://github.com/RusherDevelopment' }
27+
{ icon: {
28+
svg: "Site" //replace with an icon
29+
}, link: 'https://rusherhack.org/'
30+
},
31+
{ icon: 'github', link: 'https://github.com/RusherDevelopment' },
32+
{ icon: 'youtube', link: 'https://www.youtube.com/@RusherDevelopment' }
2533
],
2634
footer: {
27-
message: 'RusherHack and Rusher Development LLC are not affiliated with Mojang AB.',
28-
copyright: '© 2024 Rusher Development LLC - All Rights Reserved'
35+
copyright: '© 2024 Rusher Development LLC - All Rights Reserved',
36+
message: 'RusherHack and Rusher Development LLC are not affiliated with Mojang AB.'
2937
}
3038
}
3139
})
3240

3341
function sidebarBase(): DefaultTheme.SidebarItem[] {
3442
return [
3543
{
36-
text: 'Basics',
37-
link: 'basics'
44+
text: 'Guide',
45+
link: 'guide'
3846
},
3947
{
40-
text: 'Client',
41-
link: 'client'
48+
text: 'Features',
49+
link: 'features'
4250
},
4351
{
4452
text: 'API',
@@ -47,15 +55,66 @@ function sidebarBase(): DefaultTheme.SidebarItem[] {
4755
]
4856
}
4957

50-
function sidebarBasics(): DefaultTheme.SidebarItem[] {
58+
function sidebarGuide(): DefaultTheme.SidebarItem[] {
5159
return [
52-
60+
{
61+
text: 'Introduction',
62+
collapsed: false,
63+
items: [
64+
{ text: 'Account', link: 'introduction/account' },
65+
{ text: 'Installation', link: 'introduction/installation' }
66+
]
67+
},
68+
{
69+
text: 'Getting Help', link: 'help/', //will have info about help related things; opening help ticket, emailing, etc
70+
collapsed: false,
71+
items: [
72+
{ text: 'HWID', link: 'help/hwid' }
73+
]
74+
}
5375
]
5476
}
5577

56-
function sidebarClient(): DefaultTheme.SidebarItem[] {
78+
function sidebarFeatures(): DefaultTheme.SidebarItem[] {
5779
return [
58-
80+
{
81+
text: 'Modules', link: 'modules/',
82+
collapsed: false,
83+
items: [
84+
{
85+
text: 'Client',
86+
collapsed: false,
87+
items: [
88+
{ text: 'ClickGUI', link: 'modules/client/clickgui' } //just an example, in future this should be automatically generated
89+
]
90+
},
91+
{
92+
text: 'Movement',
93+
collapsed: true,
94+
items: [
95+
{ text: 'Velocity', link: 'modules/movement/velocity' } //just an example, in future this should be automatically generated
96+
]
97+
}
98+
]
99+
},
100+
{
101+
text: 'HUD Elements', link: 'hud/',
102+
collapsed: true,
103+
items: [
104+
]
105+
},
106+
{
107+
text: 'Commands', link: 'commands/',
108+
collapsed: true,
109+
items: [
110+
]
111+
},
112+
{
113+
text: 'Windows', link: 'windows/',
114+
collapsed: true,
115+
items: [
116+
]
117+
}
59118
]
60119
}
61120

@@ -72,7 +131,7 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
72131
text: 'Client',
73132
collapsed: true,
74133
items: [
75-
{ text: 'Globals', link: 'client/globals' }
134+
{ text: 'Globals', link: 'features/globals' }
76135
]
77136
},
78137
{

docs/assets/rh-head_256x256.png

1.09 KB
Loading
-5.04 KB
Binary file not shown.

docs/features/commands/index.md

Whitespace-only changes.

docs/features/hud/index.md

Whitespace-only changes.

docs/features/index.md

Whitespace-only changes.

docs/features/modules/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
A module is a feature that aids the user and helps them perform a task
2+
// fix this

docs/features/windows/index.md

Whitespace-only changes.

docs/guide/help/hwid.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
under construction
2+
3+
todo:
4+
- explain what hwid is and rusherhack is linked to computer
5+
- possible to have two hwids linked to one account

docs/guide/help/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Having an issue with RusherHack? Reach out to the support team and we will try our best to assist you!
2+
3+
Different methods of getting help:
4+
- Discord
5+
- To get access to the RusherHack Discord server, you must link your account in the [installer](../introduction/installation)
6+
- #support-and-hwid channel
7+
8+
- Direct contact with the developer
9+
- Usually responds in under 24 hours
10+
- Support Ticket
11+
- Direct contact with the developer
12+
- Usually responds in under 24 hours

0 commit comments

Comments
 (0)