v0.0.1 (#8)

.github/workflows/deploy.yml

@@ -0,0 +1,79 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main, v0.0.1]
+
+  # Allows you to run this workflow manually from the Actions tab
+  repository_dispatch:
+    types: [docc-update]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - uses: dawidd6/action-download-artifact@v6
+        with:
+          github_token: ${{ secrets.PAT_TOKEN }}
+          workflow: DocC.yml
+          name: artifact
+          repo: brightdigit/BushelKit
+          workflow_conclusion: success   
+      - name: Decompress Archive
+        run: |
+          mkdir -p public
+          tar -xf BushelKit.doccarchive.tar -C public
+          mv public/BushelKit.doccarchive public/swift-docc
+      - name: Build with VitePress
+        run: npm run docs:production # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node,npm,vuejs,typescript
+# Edit at https://www.toptal.com/developers/gitignore?templates=node,npm,vuejs,typescript
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+#!! ERROR: npm is undefined. Use list command to see defined gitignore types !!#
+
+#!! ERROR: typescript is undefined. Use list command to see defined gitignore types !!#
+
+### Vuejs ###
+# Recommended template: Node.gitignore
+
+dist/
+npm-debug.log
+yarn-error.log
+
+# End of https://www.toptal.com/developers/gitignore/api/node,npm,vuejs,typescript
+
+/coverage
+/src/client/shared.ts
+/src/node/shared.ts
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode
+dist
+cache
+temp
+examples-temp
+node_modules
+pnpm-global
+TODOs.md
+*.timestamp-*.mjs
+
+public/swift-docc

.nvmrc

@@ -0,0 +1 @@
+lts/jod

.vitepress/config.mts

@@ -0,0 +1,74 @@
+import { defineConfig } from 'vitepress'
+import * as fs from 'fs';
+import doccData from '../docc.data';
+
+const modules = doccData.load()
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Bushel API",
+  description: "Developer Docs",
+  vite : {
+    assetsInclude : ["**/*.json"]
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'REST API', link: '/rest' },
+      { text: 'CLI', link: '/cli' },
+      { text: 'Swift DocC', link: '/docc'},
+      { text: 'Get Bushel', link: 'https://getbushel.app'}
+    ],
+    sidebar: [
+      { 
+        text: "REST API",
+        items: [
+          { text: 'Introduction', link: '/rest/' },   
+          { text: 'Getting Started', link: '/rest/getting-started' },   
+          {
+            text: 'Endpoints',
+            items: [       
+              { text: 'Library', link: '/rest/endpoints/libraries' },
+              { text: 'Machine', link: '/rest/endpoints/machines' },
+              { text: 'Images', link: '/rest/endpoints/images' },
+              { text: 'Screenshots', link: '/rest/endpoints/screenshots' },
+              { text: 'Snapshots', link: '/rest/endpoints/snapshots' }
+            ]
+          }
+        ]
+      },
+      { 
+        text: "CLI",
+        items: [
+        { text: 'Introduction', link: '/cli/' },   
+        { text: 'Getting Started', link: '/cli/getting-started' },   
+        {
+          text: 'Subcommands',
+          items: [       
+            { text: 'Library', link: '/cli/subcommands/libraries' },
+            { text: 'Machine', link: '/cli/subcommands/machines' },
+            { text: 'Images', link: '/cli/subcommands/images' },
+            { text: 'Screenshots', link: '/cli/subcommands/screenshots' },
+            { text: 'Snapshots', link: '/cli/subcommands/snapshots' }
+          ]
+        }
+      ]
+    },
+    { 
+        text: "Swift DocC",
+        items: [
+        { text: 'Introduction', link: '/docc/' },    
+        {
+          text: 'Modules',
+          items: modules
+        }
+      ]
+    }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})