Merge pull request #228 from ghostdevv/docs-update

.changeset/lemon-eggs-grow.md

@@ -0,0 +1,6 @@
+---
+"create-jellycommands": patch
+"jellycommands": patch
+---
+
+chore: update jsdoc comments

package.json

@@ -35,5 +35,10 @@
 	"bugs": {
 		"url": "https://github.com/ghostdevv/jellycommands/issues"
 	},
-	"homepage": "https://github.com/ghostdevv/jellycommands#readme"
+	"homepage": "https://github.com/ghostdevv/jellycommands#readme",
+	"pnpm": {
+		"patchedDependencies": {
+			"@astrojs/starlight": "patches/@astrojs__starlight.patch"
+		}
+	}
 }

packages/create-jellycommands/src/js/src/app.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="jellycommands/ambient" />
 
-// See https://jellycommands.dev/guide/props
+// See https://jellycommands.dev/components/props
 interface Props {}

packages/create-jellycommands/src/js/src/index.js

@@ -3,7 +3,7 @@ import { JellyCommands } from 'jellycommands';
 import { IntentsBitField } from 'discord.js';
 
 const client = new JellyCommands({
-	// https://jellycommands.dev/guide/overview#components
+	// https://jellycommands.dev/components
 	components: 'src/components',
 
 	clientOptions: {
@@ -12,11 +12,11 @@ const client = new JellyCommands({
 
 	dev: {
 		// In testing we should enable this, it will make all our commands register in our testing guild
-		// https://jellycommands.dev/guide/commands/dev#global-dev-mode
+		// https://jellycommands.dev/components/commands/dev
 		global: true,
 
 		// Put your testing guild id here
-		// https://jellycommands.dev/guide/commands/dev#setup
+		// https://jellycommands.dev/components/commands/dev
 		guilds: [''],
 	},
 });

packages/create-jellycommands/src/ts/src/app.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="jellycommands/ambient" />
 
-// See https://jellycommands.dev/guide/props
+// See https://jellycommands.dev/components/props
 interface Props {}

packages/create-jellycommands/src/ts/src/index.ts

@@ -3,7 +3,7 @@ import { JellyCommands } from 'jellycommands';
 import { IntentsBitField } from 'discord.js';
 
 const client = new JellyCommands({
-	// https://jellycommands.dev/guide/overview#components
+	// https://jellycommands.dev/components
 	components: 'src/components',
 
 	clientOptions: {
@@ -12,11 +12,11 @@ const client = new JellyCommands({
 
 	dev: {
 		// In testing we should enable this, it will make all our commands register in our testing guild
-		// https://jellycommands.dev/guide/commands/dev#global-dev-mode
+		// https://jellycommands.dev/components/commands/dev
 		global: true,
 
 		// Put your testing guild id here
-		// https://jellycommands.dev/guide/commands/dev#setup
+		// https://jellycommands.dev/components/commands/dev
 		guilds: [''],
 	},
 });

packages/docs/.vitepress/config.mjs

@@ -134,7 +134,7 @@ export default defineConfig({
 					items: [
 						{
 							text: 'Components',
-							link: '/guide/components',
+							link: '/components',
 						},
 						{
 							text: 'Props',

packages/docs/astro.config.mjs

@@ -26,45 +26,47 @@ export default defineConfig({
 			},
 			lastUpdated: true,
 			plugins: [starlightLinksValidator()],
+			tableOfContents: {
+				maxHeadingLevel: 4,
+			},
 			sidebar: [
 				{
-					label: 'Guide',
+					label: 'Getting Started',
+					link: '/getting-started',
+				},
+				{
+					label: 'Components',
 					items: [
 						{
-							label: 'Get Started',
-							items: [
-								{
-									label: 'Overview',
-									link: '/guide/overview',
-								},
-								{
-									label: 'Import vs Require',
-									link: '/guide/require',
-								},
-							],
+							label: 'Understanding Components',
+							link: '/components',
 						},
 						{
 							label: 'Commands',
 							items: [
 								{
 									label: 'Creating Commands',
-									link: '/guide/commands/files',
+									link: '/components/commands',
 								},
 								{
-									label: 'Registering Commands',
-									link: '/guide/commands/registering',
+									label: 'Dev Mode',
+									link: '/components/commands/dev',
 								},
 								{
-									label: 'Dev Mode',
-									link: '/guide/commands/dev',
+									label: 'Slash Commands',
+									link: '/components/commands/slash',
 								},
 								{
-									label: 'Slash Commands Extras',
-									link: '/guide/commands/slash',
+									label: 'Context Menu Commands',
+									link: '/components/commands/context-menu',
 								},
 								{
 									label: 'Guards',
-									link: '/guide/commands/guards',
+									link: '/components/commands/guards',
+								},
+								{
+									label: 'Caching',
+									link: '/components/commands/caching',
 								},
 							],
 						},
@@ -73,7 +75,7 @@ export default defineConfig({
 							items: [
 								{
 									label: 'Creating Events',
-									link: '/guide/events/files',
+									link: '/components/events',
 								},
 							],
 						},
@@ -82,77 +84,55 @@ export default defineConfig({
 							items: [
 								{
 									label: 'Creating Buttons',
-									link: '/guide/buttons/files',
+									link: '/components/buttons',
 								},
 							],
 						},
 						{
-							label: 'Core',
-							items: [
-								{
-									label: 'Components',
-									link: '/guide/components',
-								},
-								{
-									label: 'Props',
-									link: '/guide/props',
-								},
-								{
-									label: 'Messages',
-									link: '/guide/messages',
-								},
-							],
+							label: 'Props',
+							link: '/components/props',
 						},
 						{
-							label: 'Migrate',
-							items: [
-								{
-									label: 'Components (1.0.0-next.44)',
-									link: '/guide/migrate/components',
-								},
-								{
-									label: 'Props (1.0.0-next.40)',
-									link: '/guide/migrate/props',
-								},
-								{
-									label: 'Discord.js v14 (1.0.0-next.31)',
-									link: '/guide/migrate/djs14',
-								},
-							],
+							label: 'Deferring Interactions',
+							link: '/components/deferring',
 						},
 					],
 				},
 				{
-					label: 'API',
+					label: 'Guides',
 					items: [
+						// {
+						// 	label: 'Going to production',
+						// 	link: '/guides/production',
+						// },
 						{
-							label: 'Core',
-							items: [
-								{
-									label: 'Client',
-									link: '/api/client',
-								},
-								{
-									label: 'Props',
-									link: '/api/props',
-								},
-								{
-									label: 'Commands',
-									link: '/api/commands',
-								},
-								{
-									label: 'Events',
-									link: '/api/events',
-								},
-								{
-									label: 'Buttons',
-									link: '/api/buttons',
-								},
-								{
-									label: 'App Types',
-									link: '/api/types',
-								},
-							],
+							label: 'File Loading Expanded',
+							link: '/guides/fs',
+						},
+						{
+							label: 'Messages',
+							link: '/guides/messages',
+						},
+						{
+							label: 'Import vs Require',
+							link: '/guides/require',
+						},
+					],
+				},
+				{
+					label: 'Breaking Changes',
+					items: [
+						{
+							label: 'Components (1.0.0-next.44)',
+							link: '/migrate/components',
+						},
+						{
+							label: 'Props (1.0.0-next.40)',
+							link: '/migrate/props',
+						},
+						{
+							label: 'Discord.js v14 (1.0.0-next.32)',
+							link: '/migrate/djs14',
 						},
 					],
 				},