docs: Documentation for v3.4.x Release

README.md

@@ -32,13 +32,13 @@ Deployment happens in GitHub Actions to GitHub Pages
 
 To edit files for the current version, update the files under the `docs` directory. To edit the files in a previous version, edit the files from `versioned_docs/<you version>`.
 
-1. To add a new version, make sure that the new version content is finalized in the `docs` directory, then run:
+1. To add a new version, make sure that the OLD version content is finalized in the `docs` directory, then run:
 
     ```console
-    npm run docusaurus docs:version <version number>
+    npm run docusaurus docs:version <old version number>
     ```
 
-2. Update `versions.json` to include the new version (make sure "current" is first in the array)
-3. Update `docusaurus.config.js` to set the current version's label to the new version
+2. Update `docusaurus.config.js` to set the current version's label to the new version
+3. Update `versions.json` to include the old version (keep "current" as the first element of the array)
 
 > **WARNING**: If you are editing the docs with the intention of upgrades corresponding to a new major version, please generate the past version before editing the `/docs` folder

docs/deployments/firebase.mdx

@@ -5,7 +5,6 @@ title: Firebase
 description: Guide for connecting Honeycomb to a Firebase project
 ---
 
-import firebaseActions from "../assets/firebase/firebase-actions.png";
 import firebaseConsoleSettings from "../assets/firebase/firebase-console-settings.png";
 import firebaseWebCredentials from "../assets/firebase/firebase-web-credentials.png";
 import firestoreCreateStudy from "../assets/firebase/firestore-create-study.png";
@@ -83,13 +82,13 @@ _A `command not found` error usually indicates firebase-tools has not been insta
       <br />
 
       ```shell title="env/.env.firebase"
-      REACT_APP_FIREBASE="true"
-      REACT_APP_apiKey=
-      REACT_APP_authDomain=
-      REACT_APP_projectId=
-      REACT_APP_storageBucket=
-      REACT_APP_messagingSenderId=
-      REACT_APP_appId=
+        REACT_APP_FIREBASE="true"
+        REACT_APP_API_KEY=
+        REACT_APP_AUTH_DOMAIN=
+        REACT_APP_PROJECT_ID=
+        REACT_APP_STORAGE_BUCKET=
+        REACT_APP_MESSAGING_SENDER_ID=
+        REACT_APP_APP_ID=
       ```
 
       _Additional variables may be present in the console, they do not need to be copied._
@@ -133,18 +132,16 @@ firebase init hosting:github
 1. The window should log you in automatically; if not, follow the prompts to log in with the same account you used in the console
 2. `<username>/<repository name>` refers to the name of your repository in Github - be sure it's typed correctly!
 3. Enter `y` for the prompt "Set up the workflow to run a build script before every deploy?"
-4. Enter `npm install && npm run build:firebase` for the prompt "What script should be run before every deploy?"
+4. Enter `npm ci && npm run build:firebase` for the prompt "What script should be run before every deploy?"
 5. Enter `y` to overwrite the current workflow file
 6. Enter `y` for the prompt "Set up automatic deployment to your site's live channel when a PR is merged?"
 7. Enter `main` for the prompt "What is the name of the GitHub branch associated with your site's live channel?"
 8. Enter `y` to overwrite the current workflow file
 
-Firebase will update the files `firebase-hosting-pull-request.yml` and `firebase-hosting-merge.yml` inside the `.github/workflows/` directory. Ensure the correct run script is present in both files.
+:::info
+Firebase will update the files `firebase-hosting-pull-request.yml` and `firebase-hosting-merge.yml` inside the `.github/workflows/` directory. Please ensure the "run" step is `npm ci && npm run build:firebase` in both files!
+:::
 
-<img
-  src={firebaseActions}
-  alt="Github actions created by firebase"
-/>
 
 ## Managing Data
 

docs/prerequisites.mdx

@@ -23,10 +23,6 @@ It is important that your computer is set up with the necessary packages before
 
 [Python](https://www.python.org) is a high-level programming language. Some "under the hood" tools needed by Honeycomb are written in python so it must be installed on your system.
 
-:::danger
-Honeycomb **cannot** use Python version 3.12 or newer. The installers will install version 3.11.
-:::
-
 ### Oracle JDk
 
 [Java](https://www.oracle.com/java/) is another high-level programming language that some tools are written in (namely, the Firebase Emulators). We must install a JDK (Java Development Kit) for it to run.
@@ -53,16 +49,6 @@ Honeycomb needs Java version 11 or later to run - the installers use version 18.
 
 Rosetta is a translation layer built for Mac computers with Apple Silicon. It should ask to be installed if any of the prerequisite tools need it. Otherwise, [this guide](https://support.apple.com/en-us/HT211861) can be used to make sure it is on your Apple Silicon system.
 
-## Windows-specific Install
-
-### Visual Studio
-
-[Visual Studio](https://visualstudio.microsoft.com) is a special IDE for the Windows platform. It comes with everything needed to compile desktop applications from a PC. Visual Studio Community is free to use.
-
-:::caution
-The "Desktop development with C++" workload must also be installed with Visual Studio. The automated installers should preselect this but you should double check to be certain!
-:::
-
 ## Manual Installation
 
 ### macOS
@@ -87,9 +73,6 @@ The links below will take you to each project installation page should you prefe
 - [Python](https://www.python.org/downloads/windows/)
 - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/#jdk20-mac)
 - [VS Code](https://code.visualstudio.com/download)
-- Visual Studio:
-  - [Visual Studio 2022 Community](https://visualstudio.microsoft.com/vs/community/)
-  - Install the [Native C++ Workflow](https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-160#step-4---choose-workloads-1)
 
 ### Linux
 
@@ -103,7 +86,3 @@ The links below will take you to each project installation page should you prefe
 - [VS Code](https://code.visualstudio.com/download)
 - Install [Clang](https://clang.llvm.org/get_started.html) or follow installation instructions on the [electron docs](https://www.electronjs.org/docs/development/build-instructions-linux#prerequisites)
 - Development headers of `GTK 3` and `libnotify` (Follow installation instructions on the [electron docs](https://www.electronjs.org/docs/development/build-instructions-linux#prerequisites))
-
-## Further Help
-
-If you are still having issues setting up your computer you can find the full instructions on the [electron documentation](https://www.electronjs.org/docs/development/build-instructions-gn) for your specific OS.

docs/quick_start.mdx

@@ -10,7 +10,6 @@ import TabItem from "@theme/TabItem";
 import Tabs from "@theme/Tabs";
 
 import cloneCodeButton from "./assets/clone-code-button.webp";
-import nvmrc from "./assets/nvmrc.png";
 import template0 from "./assets/template_0.png";
 import template1 from "./assets/template_1.png";
 import workflowPermissions from "./assets/workflow-permissions.png";
@@ -127,8 +126,6 @@ See [Prerequisites](prerequisites) for more information about these programs.
    ./winget.ps1
    ```
 
-4. The "Visual Studio Installer" will open a GUI during installation. Make sure "Desktop Development with C++" is checked before continuing.
-
 </TabItem>
 <TabItem
   value='mac'
@@ -195,12 +192,6 @@ NVM (Node Version Manager) is a tool for installing and using multiple versions
     </Tabs>
 
 2.  Copy the version number listed in `.nvmrc`.
-
-    <img
-      src={nvmrc}
-      alt=".nvmrc file"
-    />
-
 3.  Install that version.
 
     ```shell

docusaurus.config.js

@@ -24,14 +24,15 @@ module.exports = {
 
           /**
            * Here we give a specific label to the current doc version. Note the old versions:
+           *    '3.3.x': { label: "3.3.x", path: "3.3.x" }
            *    '3.2.x': { label: "3.2.x", path: "3.2.x" }
            *    '3.1.x': { label: '3.1.x', path: '3.1.x' },
            *    '3.0.0': { label: '3.0.0', path: '3.0.0' },
            *    '2.x': { label: '2.x', path: '2.x' },
            *    '1.1.0': { label: '1.1.0', path: '1.1.0' },
            */
           lastVersion: "current",
-          versions: { current: { label: "3.3.x", path: "" } },
+          versions: { current: { label: "3.4.x", path: "" } },
         },
         blog: false, // Disable Docusaurus blog feature
       },