Skip to content

Commit

Permalink
feat(docs): add api docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
DuroCodes committed Jan 28, 2023
1 parent 22e31a6 commit 43c6c21
Show file tree
Hide file tree
Showing 31 changed files with 713 additions and 39 deletions.
3 changes: 2 additions & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"lint": "next lint",
"vercel-build": "prisma generate && next build",
"prisma:generate": "prisma generate",
"docgen": "node src/utils/docgen.mjs"
"docgen": "rm -rf src/pages/docs && node src/utils/docgen.mjs && node src/utils/docgen.mjs"
},
"author": "DuroCodes",
"license": "MIT",
Expand All @@ -26,6 +26,7 @@
"@trpc/react-query": "^10.6.0",
"@trpc/server": "^10.6.0",
"copy-to-clipboard": "3.3.2",
"fast-glob": "^3.2.12",
"next": "12.3.1",
"next-auth": "^4.18.6",
"next-mdx-remote": "^4.2.0",
Expand Down
8 changes: 4 additions & 4 deletions apps/docs/src/components/QuickStart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ export const QuickStartArea = () => (
name: 'Create a new project',
description: 'Build a new Discord bot with Spark.',
}}
href="/docs/getting-started/create-new"
href="/guide/getting-started/create-new"
/>
<DetailedFeatureLink
feature={{
Icon: ServerIcon,
name: 'Add to your project',
description: 'Add things to your bot with Spark.',
}}
href="/docs/getting-started/add-to-project"
href="/guide/getting-started/add-to-project"
/>
</div>
);
Expand All @@ -35,15 +35,15 @@ export const FeatureArea = () => (
name: 'Adding commands',
description: 'Add new commands to your project.',
}}
href="/docs/core-concepts/adding-commands"
href="/guide/core-concepts/adding-commands"
/>
<DetailedFeatureLink
feature={{
Icon: ChatIcon,
name: 'Adding events',
description: 'Add new events to your project.',
}}
href="/docs/core-concepts/adding-events"
href="/guide/core-concepts/adding-events"
/>
</div>
);
2 changes: 1 addition & 1 deletion apps/docs/src/components/pages/plugin/newPlugin.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export default function NewPlugin() {
<h1><span className="font-bold leading-tight lg:text-5xl">New Plugin</span></h1>
<div className="text-center text-gray-500 dark:text-gray-400">
<p>Create a plugin for the Spark community.</p>
<Link href="/docs/core-concepts/publishing-plugins">Click here</Link> for a guide on how to publish plugins.
<Link href="/guide/core-concepts/publishing-plugins">Click here</Link> for a guide on how to publish plugins.
</div>
</div>
<form
Expand Down
3 changes: 2 additions & 1 deletion apps/docs/src/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@
"toc": true
}
},
"docs": "Docs & Guide",
"guide": "Guide",
"blog": {
"title": "Blog",
"theme": {
"typesetting": "article"
}
},
"docs": "API Docs",
"plugins": "Plugins"
}
11 changes: 3 additions & 8 deletions apps/docs/src/pages/docs/_meta.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
{
"index": {
"title": "Quickstart"
},
"api": "API",
"getting-started": "Getting Started",
"core-concepts": "Core Concepts",
"faq": "FAQ"
}
"classes": "Classes",
"types": "Types"
}
6 changes: 0 additions & 6 deletions apps/docs/src/pages/docs/api/index.mdx

This file was deleted.

Loading

0 comments on commit 43c6c21

Please sign in to comment.