Merge pull request #181 from bluecadet/feat/2.0-docs

Feat/2.0 docs

README.md

@@ -0,0 +1,25 @@
+# 🚀 Launchpad
+
+Launchpad is a suite of tools for managing interactive installations. It provides content management, process monitoring, and system configuration capabilities.
+
+## Documentation
+
+For complete documentation, configuration options, and guides, visit:
+[Launchpad Documentation](https://bluecadet.github.io/launchpad/)
+
+## Core Packages
+
+- [@bluecadet/launchpad-cli](./packages/cli): Command line interface and configuration management
+- [@bluecadet/launchpad-content](./packages/content): Content pipeline and transformation tools
+- [@bluecadet/launchpad-monitor](./packages/monitor): Process monitoring and management
+- [@bluecadet/launchpad-scaffold](./packages/scaffold): System configuration
+- [@bluecadet/launchpad-utils](./packages/utils): Shared utilities
+- [@bluecadet/launchpad](./packages/launchpad): Meta-package that installs all core packages
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development guidelines.
+
+## License
+
+MIT © Bluecadet

biome.json

@@ -8,7 +8,7 @@
 	"files": {
 		"ignoreUnknown": false,
 		"ignore": [],
-		"include": ["**/src/**/*.ts"]
+		"include": ["**/src/**/*.ts", "docs/**/*.ts", "docs/**/*.mts"]
 	},
 	"formatter": {
 		"enabled": true,

docs/.vitepress/config.mts

@@ -1,70 +1,135 @@
-import { defineConfig } from 'vitepress'
-import pkg from '../../packages/launchpad/package.json'
+import { defineConfig } from "vitepress";
+import pkg from "../../packages/launchpad/package.json";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  lang: 'en-US',
-  title: "Launchpad",
-  description: "A suite of tools to manage media installations",
-  lastUpdated: true,
-  ignoreDeadLinks: true, // TODO: disable after writing all docs
-  base: '/launchpad/',
-  themeConfig: {
-    search: {
-      provider: 'local'
-    },
+	lang: "en-US",
+	title: "Launchpad",
+	description: "A suite of tools to manage media installations",
+	lastUpdated: true,
+	base: "/launchpad/",
+	srcDir: "src",
 
-    nav: [
-      {
-        text: pkg.version,
-        items: [
-          {
-            text: 'Changelog',
-            link: 'https://github.com/bluecadet/launchpad/releases'
-          },
-          {
-            text: 'Contributing',
-            link: 'https://github.com/bluecadet/launchpad/blob/develop/CONTRIBUTING.md'
-          }
-        ]
-      }
-    ],
+	themeConfig: {
+		siteTitle: "🚀 Launchpad",
+		search: {
+			provider: "local",
+		},
+		outline: {
+			level: [2, 3],
+		},
+		nav: [
+			{
+				text: pkg.version,
+				items: [
+					{
+						text: "Changelog",
+						link: "https://github.com/bluecadet/launchpad/releases",
+					},
+					{
+						text: "Contributing",
+						link: "https://github.com/bluecadet/launchpad/blob/develop/CONTRIBUTING.md",
+					},
+				],
+			},
+		],
 
-    sidebar: [
-      {
-        text: 'Guides',
-        items: [
-          { text: 'Introduction', link: '/' },
-          { text: 'Getting Started', link: '/guides/getting-started' },
-        ]
-      },
-      {
-        text: 'Content',
-        items: [
-          { text: 'Overview', link: '/content/overview' },
-          { text: 'Caching & Updates', link: '/content/caching' }
-        ]
-      },
-      {
-        text: 'CLI',
-        items: [
-          { text: 'Commands', link: '/cli/commands' }
-        ]
-      }
-    ],
+		sidebar: [
+			{
+				text: "Guides",
+				items: [
+					{ text: "Introduction", link: "/" },
+					{ text: "Getting Started", link: "/guides/getting-started" },
+					{ text: "Fetching Content", link: "/guides/fetching-content" },
+					{ text: "Downloading Media", link: "/guides/downloading-media" },
+					{ text: "Running Applications", link: "/guides/running-applications" },
+				],
+			},
+			{
+				text: "Recipes",
+				items: [
+					{ text: "Custom Content Source", link: "/recipes/custom-content-source" },
+					{ text: "Custom Content Plugin", link: "/recipes/custom-content-plugin" },
+					{ text: "Custom Monitor Plugin", link: "/recipes/custom-monitor-plugin" },
+				],
+			},
+			{
+				text: "Reference",
+				items: [
+					{
+						text: "CLI",
+						link: "/reference/cli",
+						items: [
+							{ text: "Env", link: "/reference/cli/env" },
+							{ text: "Config Loading", link: "/reference/cli/config-loading" },
+							{ text: "Commands", link: "/reference/cli/commands" },
+						],
+					},
+					{
+						text: "Content",
+						link: "/reference/content",
+						items: [
+							{ text: "Content Config", link: "/reference/content/content-config" },
+							{
+								text: "Sources",
+								link: "/reference/content/sources",
+								items: [
+									{ text: "airtableSource", link: "/reference/content/sources/airtable-source" },
+									{
+										text: "contentfulSource",
+										link: "/reference/content/sources/contentful-source",
+									},
+									{ text: "jsonSource", link: "/reference/content/sources/json-source" },
+									{ text: "sanitySource", link: "/reference/content/sources/sanity-source" },
+									{ text: "strapiSource", link: "/reference/content/sources/strapi-source" },
+								],
+							},
+							{
+								text: "Plugins",
+								link: "/reference/content/plugins",
+								items: [
+									{ text: "mdToHtml", link: "/reference/content/plugins/md-to-html" },
+									{ text: "sanityToHtml", link: "/reference/content/plugins/sanity-to-html" },
+									{ text: "sanityToPlain", link: "/reference/content/plugins/sanity-to-plain" },
+									{ text: "sanityToMd", link: "/reference/content/plugins/sanity-to-md" },
+									{ text: "mediaDownloader", link: "/reference/content/plugins/media-downloader" },
+									{ text: "sharp", link: "/reference/content/plugins/sharp" },
+									{
+										text: "sanityImageUrlTransform",
+										link: "/reference/content/plugins/sanity-image-url-transform",
+									},
+								],
+							},
+							{ text: "DataStore", link: "/reference/content/data-store" },
+						],
+					},
+					{
+						text: "Monitor",
+						link: "/reference/monitor",
+						items: [
+							{ text: "Monitor Config", link: "/reference/monitor/monitor-config" },
+							{ text: "Plugins", link: "/reference/monitor/plugins" },
+						],
+					},
+					{
+						text: "Scaffold",
+						link: "/reference/scaffold",
+						items: [{ text: "Scaffold Config", link: "/reference/scaffold/scaffold-config" }],
+					},
+				],
+			},
+		],
 
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/bluecadet/launchpad' }
-    ],
+		socialLinks: [{ icon: "github", link: "https://github.com/bluecadet/launchpad" }],
 
-    editLink: {
-      pattern: 'https://github.com/bluecadet/launchpad/edit/develop/docs/:path',
-      text: 'Edit this page on GitHub'
-    },
+		editLink: {
+			pattern: "https://github.com/bluecadet/launchpad/edit/develop/docs/:path",
+			text: "Edit this page on GitHub",
+		},
 
-    footer: {
-      message: 'Released under the MIT License.',
-      copyright: 'Copyright © 2024 Bluecadet'
-    }
-  }
-})
+		footer: {
+			message: "Released under the MIT License.",
+			copyright: "Copyright © 2024 Bluecadet",
+		},
+	},
+});

docs/.vitepress/theme/index.ts

@@ -1,17 +1,17 @@
+import type { Theme } from "vitepress";
+import DefaultTheme from "vitepress/theme";
 // https://vitepress.dev/guide/custom-theme
-import { h } from 'vue'
-import type { Theme } from 'vitepress'
-import DefaultTheme from 'vitepress/theme'
-import './style.css'
+import { h } from "vue";
+import "./style.css";
 
 export default {
-  extends: DefaultTheme,
-  Layout: () => {
-    return h(DefaultTheme.Layout, null, {
-      // https://vitepress.dev/guide/extending-default-theme#layout-slots
-    })
-  },
-  enhanceApp({ app, router, siteData }) {
-    // ...
-  }
-} satisfies Theme
+	extends: DefaultTheme,
+	Layout: () => {
+		return h(DefaultTheme.Layout, null, {
+			// https://vitepress.dev/guide/extending-default-theme#layout-slots
+		});
+	},
+	enhanceApp({ app, router, siteData }) {
+		// ...
+	},
+} satisfies Theme;