Merge branch 'trunk' into advay/enhance-cli-dataset-docs

.github/workflows/build_and_publish.yml

@@ -24,17 +24,17 @@ jobs:
           node-version: 20
 
       - name: Install dependencies
-        working-directory: spiceaidocs
+        working-directory: website
         run: npm install
 
       - name: Build website
-        working-directory: spiceaidocs
+        working-directory: website
         run: npm run build
 
       - name: Deploy
         if: ${{ github.event_name != 'pull_request' && startswith(github.ref, 'refs/tags/v') }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./spiceaidocs/build
+          publish_dir: ./website/build
           cname: docs.spiceai.org

.github/workflows/updated_openapi.yml

@@ -3,7 +3,7 @@ name: Generate API Docs
 on:
   pull_request:
     paths:
-      - "spiceaidocs/public/openapi.json"
+      - "website/public/openapi.json"
 
 jobs:
   generate-api-docs:
@@ -22,7 +22,7 @@ jobs:
         run: npm ci
 
       - name: Generate API docs
-        working-directory: spiceaidocs
+        working-directory: website
         run: |
           rm docs/api/HTTP/*
           npm run docusaurus gen-api-docs all

.gitignore

@@ -1,8 +1,8 @@
 .DS_Store
 node_modules
 
-spiceaidocs/resources
-spiceaidocs/public
+website/resources
+website/public
 
 .hugo_build.lock
 

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "spiceaidocs/themes/docsy"]
-	path = spiceaidocs/themes/docsy
+[submodule "website/themes/docsy"]
+	path = website/themes/docsy
 	url = https://github.com/google/docsy.git

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "tabWidth": 2,
+  "plugins": [
+    "prettier-plugin-tailwindcss"
+  ],
+  "printWidth": 100,
+  "trailingComma": "none",
+  "arrowParens": "always"
+}

README.md

@@ -10,7 +10,7 @@ This repo contains the markdown files which generate the above website. See belo
 
 The Spice docs are built using [Docusaurus](https://docusaurus.io/) hosted on [GitHub Pages](https://pages.github.com/).
 
-The [spiceaidocs](./spiceaidocs) directory contains the Docusaurus project, markdown files, and theme configurations.
+The [website](./website) directory contains the Docusaurus project, markdown files, and theme configurations.
 
 ## Pre-requisites
 
@@ -26,10 +26,10 @@ The [spiceaidocs](./spiceaidocs) directory contains the Docusaurus project, mark
 git clone https://github.com/spiceai/docs.git
 ```
 
-3. Change to spiceaidocs directory:
+3. Change to website directory:
 
 ```sh
-cd ./docs/spiceaidocs
+cd ./docs/website
 ```
 
 4. Install npm packages:
@@ -40,7 +40,7 @@ npm install
 
 ## Run local server
 
-1. Make sure you're still in the `spiceaidocs` directory
+1. Make sure you're still in the `website` directory
 2. Run
 
 ```sh