adding docusaurus docs

.github/workflows/docs-build-test.yml

@@ -0,0 +1,30 @@
+name: Test Docs deployment
+
+on:
+ push:
+ paths:
+ - 'www/**'
+
+ # 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
+
+jobs:
+
+ test-deploy:
+ defaults:
+ run:
+ shell: bash
+ working-directory: www/
+ name: Test deployment
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ cache: yarn
+
+ - name: Install dependencies
+ run: yarn install --frozen-lockfile
+ - name: Test build website
+ run: yarn build

.gitignore

@@ -137,4 +137,27 @@ ghidriffs/
 # pytest data (pulled from https://github.com/clearbluejar/ghidriff-test-data)
 tests/data
 
-.DS_Store
+.DS_Store
+
+
+# docusaurus .gitignore
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

www/docs/diffs/_category_.json

@@ -0,0 +1,8 @@
+{
+ "label": "Diffs",
+ "position": 5,
+ "link": {
+ "type": "generated-index",
+ "description": "5 minutes to learn the most important Docusaurus concepts."
+ }
+}

www/docs/diffs/test.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: 'Hi!'
+sidebar_position: 3
+---
+
+# Hello
+
+This is my **first Docusaurus document**!

www/docs/guides/_category_.json

@@ -0,0 +1,8 @@
+{
+ "label": "Tutorial",
+ "position": 2,
+ "link": {
+ "type": "generated-index",
+ "description": "5 minutes to learn the most important Docusaurus concepts."
+ }
+}