feature: update the ordering of all elements in the sidebar

DiscordLuau · Jun 20, 2024 · 95e0a11 · 95e0a11
1 parent 789ee33
commit 95e0a11
Show file tree

Hide file tree

Showing 85 changed files with 451 additions and 197 deletions.
diff --git a/.lune/generator/markdown.luau b/.lune/generator/markdown.luau
@@ -57,8 +57,9 @@ end
 local function frontmatter(source: {
 	name: string,
 	description: string,
+	order: number,
 })
-	return `---\ntitle: {source.name}\ndescription: {source.description}\n---`
+	return `---\ntitle: {source.name}\ndescription: {source.description}\nsidebar:\n order: {source.order}\n collapsed: true\n---`
 end
 
 function Markdown.generateMarkdownDocumentFor(classDocumentation: Moonwave.moonwaveDataExportObject)
@@ -78,6 +79,8 @@ function Markdown.generateMarkdownDocumentFor(classDocumentation: Moonwave.moonw
 
 	local inheritedClasses = classDocumentation.inherited ~= nil and classDocumentation.inherited or { }
 
+	local order = #string.split(classDocumentation.name, ".")
+
 	for _, classObject in inheritedClasses do
 		sizeOfClassProperties += #classObject.properties
 
@@ -93,6 +96,7 @@ function Markdown.generateMarkdownDocumentFor(classDocumentation: Moonwave.moonw
 	markdownFile ..= frontmatter({
 		name = className,
 		description = `DiscordLuau docs for {className}.`,
+		order = order,
 	})
 
 	markdownFile ..= newline()

diff --git a/discord-luau b/discord-luau
diff --git a/src/content/docs/classes/Builders/ActivityBuilder.mdx b/src/content/docs/classes/Builders/ActivityBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: ActivityBuilder
 description: DiscordLuau docs for ActivityBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/AttachmentBuilder.mdx b/src/content/docs/classes/Builders/AttachmentBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: AttachmentBuilder
 description: DiscordLuau docs for AttachmentBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx b/src/content/docs/classes/Builders/AutomoderationRuleBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: AutomoderationRuleBuilder
 description: DiscordLuau docs for AutomoderationRuleBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/ChannelBuilder.mdx b/src/content/docs/classes/Builders/ChannelBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: ChannelBuilder
 description: DiscordLuau docs for ChannelBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/CommandBuilder.mdx b/src/content/docs/classes/Builders/CommandBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: CommandBuilder
 description: DiscordLuau docs for CommandBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/CommandOptionBuilder.mdx b/src/content/docs/classes/Builders/CommandOptionBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: CommandOptionBuilder
 description: DiscordLuau docs for CommandOptionBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/DiscordPermission.mdx b/src/content/docs/classes/Builders/DiscordPermission.mdx
@@ -1,6 +1,9 @@
 ---
 title: DiscordPermission
 description: DiscordLuau docs for DiscordPermission.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/EmbedBuilder.mdx b/src/content/docs/classes/Builders/EmbedBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: EmbedBuilder
 description: DiscordLuau docs for EmbedBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/GuildBuilder.mdx b/src/content/docs/classes/Builders/GuildBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: GuildBuilder
 description: DiscordLuau docs for GuildBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/GuildRoleBuilder.mdx b/src/content/docs/classes/Builders/GuildRoleBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: GuildRoleBuilder
 description: DiscordLuau docs for GuildRoleBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/IntentsBuilder.mdx b/src/content/docs/classes/Builders/IntentsBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: IntentsBuilder
 description: DiscordLuau docs for IntentsBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx b/src/content/docs/classes/Builders/Interface/ActionRowBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: ActionRowBuilder
 description: DiscordLuau docs for ActionRowBuilder.
+sidebar:
+ order: 3
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx b/src/content/docs/classes/Builders/Interface/ButtonBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: ButtonBuilder
 description: DiscordLuau docs for ButtonBuilder.
+sidebar:
+ order: 3
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx b/src/content/docs/classes/Builders/Interface/SelectionBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: SelectionBuilder
 description: DiscordLuau docs for SelectionBuilder.
+sidebar:
+ order: 3
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx b/src/content/docs/classes/Builders/Interface/TextInputBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: TextInputBuilder
 description: DiscordLuau docs for TextInputBuilder.
+sidebar:
+ order: 3
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/MemberBuilder.mdx b/src/content/docs/classes/Builders/MemberBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: MemberBuilder
 description: DiscordLuau docs for MemberBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/MessageBuilder.mdx b/src/content/docs/classes/Builders/MessageBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: MessageBuilder
 description: DiscordLuau docs for MessageBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/ModalBuilder.mdx b/src/content/docs/classes/Builders/ModalBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: ModalBuilder
 description: DiscordLuau docs for ModalBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/OnboardingBuilder.mdx b/src/content/docs/classes/Builders/OnboardingBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: OnboardingBuilder
 description: DiscordLuau docs for OnboardingBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx b/src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: OnboardingPromptBuilder
 description: DiscordLuau docs for OnboardingPromptBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx b/src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: OnboardingPromptOptionBuilder
 description: DiscordLuau docs for OnboardingPromptOptionBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/PermissionsBuilder.mdx b/src/content/docs/classes/Builders/PermissionsBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: PermissionsBuilder
 description: DiscordLuau docs for PermissionsBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/PresenceBuilder.mdx b/src/content/docs/classes/Builders/PresenceBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: PresenceBuilder
 description: DiscordLuau docs for PresenceBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/SettingsBuilder.mdx b/src/content/docs/classes/Builders/SettingsBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: SettingsBuilder
 description: DiscordLuau docs for SettingsBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx b/src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx
@@ -1,6 +1,9 @@
 ---
 title: WelcomeScreenBuilder
 description: DiscordLuau docs for WelcomeScreenBuilder.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/DiscordClient.mdx b/src/content/docs/classes/DiscordClient.mdx
@@ -1,6 +1,9 @@
 ---
 title: DiscordClient
 description: DiscordLuau docs for DiscordClient.
+sidebar:
+ order: 1
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/DiscordLuau.mdx b/src/content/docs/classes/DiscordLuau.mdx
@@ -1,6 +1,9 @@
 ---
 title: DiscordLuau
 description: DiscordLuau docs for DiscordLuau.
+sidebar:
+ order: 1
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)

diff --git a/src/content/docs/classes/Network/DiscordGateway.mdx b/src/content/docs/classes/Network/DiscordGateway.mdx
@@ -1,6 +1,9 @@
 ---
 title: DiscordGateway
 description: DiscordLuau docs for DiscordGateway.
+sidebar:
+ order: 2
+ collapsed: true
 ---
 [//]: # (This file was automatically compiled through the Generator luau code under this repository)
 [//]: # (if you want to edit the documentation of discord-luau, please write changes)
+16 −16		Package/Classes/Network/DiscordShard.luau
+2 −2		Package/Classes/Network/DiscordVoiceConnection.luau
+1 −1		Package/Classes/Network/Resolvable.luau
+2 −2		Package/Classes/Objects/BaseGuildThread.luau
+2 −2		Package/Classes/Objects/DiscordAutomoderationRule.luau
+1 −1		Package/Classes/Objects/DiscordGuild.luau
+2 −2		Package/Classes/Objects/DiscordInvite.luau
+2 −2		Package/Classes/Objects/DiscordMessage.luau