Merge pull request #2 from robotgoat/main

Modern Documentation Website

Author: sensei-hacker

.github/workflows/deploy.yml

@@ -0,0 +1,61 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+defaults:
+  run:
+    shell: bash
+    
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: npm run build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,23 +1,20 @@
-*.gem
-*.swp
-*~
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
 .DS_Store
-.analysis
-.bundle/
-.byebug_history
-.jekyll-metadata
-.ruby-gemset
-.ruby-version
-.sass-cache
-/test/source/file_name.txt
-/vendor
-Gemfile.lock
-_site/
-bin/
-bbin/
-coverage
-gh-pages/
-pkg/
-site/_site/
-test/dest
-tmp/*
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

CNAME

@@ -0,0 +1,32 @@
+# INAV: The New Documentation Project
+
+![INAV](static/img/inav_home_dark.svg)
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/iNavFlight/inav/nightly-build.yml?label=Nightly)
+![GitHub Tag](https://img.shields.io/github/v/tag/iNavFlight/inav?label=Release)
+![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)
+
+
+This project is the new and updated documentation built using Docusaurus V3.9. 
+The current INAV documentation is scattered about in the Github Wiki and the docs directory of the main project. 
+This documentation attempts to consolidate all the knowledge about INAV into a centralized, easy to access and read location.
+
+To build and run the docs locally, install npm on your system and follow the Docusaurus installation instructions. 
+
+- Prepare the environment with `npm run clear` and `rm package-lock.json`.
+- Make sure all packages are installed with `npm install`.
+- Run the dev server with `npm run start`.
+
+The temporary documentation can be accessed at this URL: https://www.spiffygoose.com/inavdocs/
+
+## Versioning Scheme
+
+The website utilizes Docusaurus's versioning feature to keep track of major changes to the firmware.
+The current version is the active stable release in the main `./docs` directory that is intended to be continually updated with minor updates until the next version. 
+Upon the release of the next stable version, the current version will be archived (versioned) into its own directory using `npm run docusaurus docs:version x.y.z`
+Lastly, the next current version's label will updated in `docusaurus.config.ts`.
+
+## Plugins Used
+
+* The search plugin used is docusaurus-lunr-search: https://github.com/praveenn77/docusaurus-lunr-search
+* Image zoom plugin: https://github.com/gabrielcsapo/docusaurus-plugin-image-zoom