Merge branch 'dev' into feat/web-ext

Author: KTrain5169

.github/workflows/docs.yml

@@ -65,6 +65,7 @@ jobs:
                 key: neuropilot-docs-${{ github.repository }}
                 path: |
                     docs/.astro
+                    docs/.cache
                     docs/dist
                     docs/node_modules
             
@@ -94,7 +95,7 @@ jobs:
               env:
                 PUBLIC_VERSION: ${{ steps.docs-ver.outputs.version }}
               working-directory: ${{ github.workspace }}/docs
-              run: npm run build
+              run: PUBLIC_VERSION=$(npm show ./ version) npm run build
 
             - name: Upload GitHub Pages Artifact
               uses: actions/upload-pages-artifact@2d163be3ddce01512f3eea7ac5b7023b5d643ce1 # Pinning to SHA because that thing hasn't updated in a year it seems

.gitignore

@@ -18,6 +18,7 @@ dist/
 !.github/actions/get-package-json-version/dist/
 # generated astro types
 .astro/
+.cache/
 
 # logs
 npm-debug.log*

README.md

@@ -1,13 +1,18 @@
 // @ts-check
 import { defineConfig } from 'astro/config';
 import starlight from '@astrojs/starlight';
+import starlightHeadingBadgesPlugin from 'starlight-heading-badges';
+import { BASE_GITHUB_URL, MARKETPLACE_URL } from './consts/links';
+
+/** @todo https://starlight.astro.build/resources/plugins/#plugins */
 
 // https://astro.build/config
 export default defineConfig({
     site: 'https://vsc-neuropilot.github.io/neuropilot',
     base: '/neuropilot',
     integrations: [
         starlight({
+            plugins: [starlightHeadingBadgesPlugin()],
             favicon: '/heart-pink.svg',
             customCss: [
                 './src/styles/icons.css'
@@ -22,6 +27,10 @@ export default defineConfig({
                 }
             ],
             title: 'NeuroPilot Docs',
+            editLink: {
+                baseUrl: BASE_GITHUB_URL + '/edit/master/docs'
+            },
+            lastUpdated: true,
             logo: {
                 dark: './src/assets/evilpilot.svg',
                 light: './src/assets/neuropilot.svg',
@@ -31,12 +40,12 @@ export default defineConfig({
                 {
                     icon: 'vscode',
                     label: 'NeuroPilot listing on Visual Studio Marketplace',
-                    href: 'https://marketplace.visualstudio.com/items?itemName=Pasu4.neuropilot',
+                    href: MARKETPLACE_URL("page"),
                 },
                 {
                     icon: 'github',
                     label: 'NeuroPilot GitHub',
-                    href: 'https://github.com/VSC-NeuroPilot/neuropilot',
+                    href: BASE_GITHUB_URL,
                 },
             ],
             sidebar: [
@@ -45,6 +54,7 @@ export default defineConfig({
                     items: [
                         {
                             label: 'Setup NeuroPilot',
+                            badge: { text: 'Start here!', variant: 'tip' },
                             slug: 'guides/setup',
                         },
                         {
@@ -53,6 +63,7 @@ export default defineConfig({
                         },
                         {
                             label: 'Sandboxing',
+                            badge: { text: 'WIP', variant: 'caution' },
                             slug: 'guides/sandboxing'
                         }
                     ],
@@ -67,19 +78,34 @@ export default defineConfig({
                                 collapsed: true
                             }
                         },
-                        { label: 'Safety', slug: 'reference/safety' },
+                        { label: 'Safety', slug: 'reference/safety', badge: { text: 'Important', variant: 'danger' } },
                         { label: 'Commands', slug: 'reference/commands' },
-                        { label: 'Context', slug: 'reference/auto-context' },
-                        { label: 'Cookies', slug: 'reference/cookies' },
-                        { label: 'Cursor', slug: 'reference/cursor' },
-                        { label: 'Permissions', slug: 'reference/permissions' },
-                        { label: 'RCE', slug: 'reference/rce' },
+                        { label: 'Context', slug: 'reference/auto-context', badge: { text: 'Stub', variant: 'caution' } },
+                        { label: 'Cookies', slug: 'reference/cookies', badge: { text: 'Stub', variant: 'caution' } },
+                        { label: 'Cursor', slug: 'reference/cursor', badge: { text: 'Conditional', variant: 'success' } },
+                        { label: 'Permissions', slug: 'reference/permissions', badge: { text: 'Important', variant: 'danger' } },
+                        { label: 'RCE', slug: 'reference/rce', badge: { text: 'Core', variant: 'note' } },
                         { label: 'Settings', slug: 'reference/settings' },
                         { label: 'Dependencies', slug: 'reference/dependencies' },
                     ],
                 },
-                "assets",
+                {
+                    label: 'NeuroPilot Assets',
+                    badge: { text: 'Meta', variant: 'note' },
+                    slug: 'assets'
+                },
+                {
+                    label: 'Contributors',
+                    badge: { text: 'Meta', variant: 'note' },
+                    autogenerate: {
+                        directory: 'contributors',
+                        collapsed: true
+                    }
+                }
             ],
+            components: {
+                Footer: './src/components/Footer.astro'
+            }
         }),
     ],
 });

docs/astro.config.mts

@@ -0,0 +1,10 @@
+export const BASE_GITHUB_URL: string = "https://github.com/VSC-NeuroPilot/neuropilot"
+type MarketplaceLinks = "page" | "direct"
+export const MARKETPLACE_URL = (type: MarketplaceLinks) => {
+    if (type === "page") {
+        return "https://marketplace.visualstudio.com/items?itemName=Pasu4.neuropilot"
+    } else if (type === "direct") {
+        return "vscode:extension/Pasu4.neuropilot"
+    } else
+        return "/"
+}