Merge pull request #129 from brown-ccv/ref-versioned-images

ref: Documentation images belong to their specific version

docs/deployments/firebase.mdx

@@ -5,11 +5,11 @@ 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";
-import firestoreExampleStudy from "/assets/firebase/firestore-example-study.png";
+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";
+import firestoreExampleStudy from "../assets/firebase/firestore-example-study.png";
 
 Honeycomb comes with methods and configurations to deploy tasks with [Firebase](https://firebase.google.com/). These tools make it possible to reach a wider audience by hosting your task online.
 

docs/deployments/gh_pages.mdx

@@ -7,7 +7,6 @@ description: Guide for deploying a task to GitHub Pages
 
 The `.github/workflows/release.yml` workflow will automatically deploy your task to GitHub pages if you have it enabled for your repository. It uploads the built website to the `gh-pages` branch. You can then access your task at `<github user>.github.io/<repository>`.
 
-
 :::danger
 Session data is downloaded to the user's local machine upon completion of the experiment when using GH Pages. Because of this, GH Pages is not suitable for fully online experiments.
 :::

docs/further_reading/version_control.mdx

@@ -5,25 +5,41 @@ title: Version Control
 description: "Version control basics with Git and GitHub"
 ---
 
+import gitBasics from "../assets/further_reading/git_basics.png";
+import gitBranch from "../assets/further_reading/git_branch.png";
+import createPR from "../assets/further_reading/create_pull_request.png";
+import addReviewers from "../assets/further_reading/add_reviewers.png";
+
 ## Git Overview
 
 Git is a version control system that enables you to track changes to files. With Git, you are able to revert files back to previous versions, restore deleted files, remove added files and even track down where a particular line of code was introduced.
 
 Nearly all operations that are performed by Git are in your local computing environment, with the exception of a few used to synchronize with the GitHub remote host. Some of the most common git operations are depicted below.
 
-![Git basics](/assets/further_reading/git_basics.png)
+<img
+  src={gitBasics}
+  alt="Git basics"
+/>
 
 If you would like to make any changes to current repository, it is always good to start with creating a feature branch, where you can save all the changes.
 
-![Example branch](/assets/further_reading/git_branch.png)
+<img
+  src={gitBranch}
+  alt="Example branches diagram"
+/>
 
 ## Create a Pull Request
 
 Pull requests are useful before you merge your branch with the main branch. You can request a review from your colleagues and check for any conflicts with the main branch. After you pushed all the changes to your branch, you can go to the original GitHub repository and click on the pull request.
 
-![git pr](/assets/further_reading/create_pull_request.png)
-
-![git pr info](/assets/further_reading/add_reviewers.png)
+<img
+  src={createPR}
+  alt="Create a pull request"
+/>
+<img
+  src={addReviewers}
+  alt="Add reviewers to a pull request"
+/>
 
 ## Best Practices
 

docs/quick_start.mdx

@@ -5,25 +5,40 @@ title: Quick Start
 description: Quick start guide for Honeycomb
 ---
 
-import Tabs from "@theme/Tabs";
-import TabItem from "@theme/TabItem";
 import CodeBlock from "@theme/CodeBlock";
-import cloneCodeButton from "/assets/clone-code-button.webp";
-import nvmrc from "/assets/nvmrc.png";
-import workflowPermissions from "/assets/workflow-permissions.png";
+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";
+import powershellAdmin from "./assets/powershell_admin.png";
 
 ## Creating Your Task Repository
 
 The Honeycomb repository is a template and serves as the starting point for all tasks. Creating your repository from the template starts your project with the same directory structure and files as an existing repository.
 
 1. Go to the [Honeycomb repository](https://github.com/brown-ccv/honeycomb)
 2. Click on `Use this template` and select `Create a new repository`.
-   ![Use this template](/assets/template_0.png)
+
+   <img
+     src={template0}
+     alt="Use this template"
+   />
+
 3. Enter the owner, name, and description of your repository and click on `Create repository from template`.
-   ![Create repository](/assets/template_1.png)
+
+   <img
+     src={template1}
+     alt="Create the repository"
+   />
+
    :::note
    We recommend creating a public repository and leaving `Include all branches` unchecked
    :::
+
 4. Ensure the repository's workflow permissions are set to "Read and write permissions"
 
    _`Settings -> Actions -> General -> Workflow permissions`_
@@ -100,7 +115,10 @@ See [Prerequisites](prerequisites) for more information about these programs.
 
 1. Run Powershell as an admin from the start menu
 
-   ![Powershell admin launcher](/assets/powershell_admin.png)
+   <img
+     src={powershellAdmin}
+     alt="Powershell admin launcher"
+   />
 
 2. Navigate to the root directory of your cloned repository
 3. Paste the following command and follow the prompts to install the listed programs:

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "honeycomb",
-  "version": "0.0.0",
+  "name": "honeycomb-docs",
+  "version": "3.3.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

versioned_docs/version-3.2.x/deployments/firebase.mdx

@@ -5,11 +5,11 @@ 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";
-import firestoreExampleStudy from "/assets/firebase/firestore-example-study.png";
+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";
+import firestoreExampleStudy from "../assets/firebase/firestore-example-study.png";
 
 Honeycomb comes with methods and configurations to deploy tasks with [Firebase](https://firebase.google.com/). These tools make it possible to reach a wider audience by hosting your task online.
 

versioned_docs/version-3.2.x/further_reading/version_control.mdx

@@ -11,19 +11,19 @@ Git is a version control system that enables you to track changes to files. With
 
 Nearly all operations that are performed by Git are in your local computing environment, for the exception of few used purely to synchronize with a remote. Some of the most common git operations are depicted below.
 
-![Git basics](/assets/further_reading/git_basics.png)
+![Git basics](../assets/further_reading/git_basics.png)
 
 If you would like to make any changes to current repository, it is always good to start with creating a feature branch, where you can save all the changes.
 
-![Example branch](/assets/further_reading/git_branch.png)
+![Example branch](../assets/further_reading/git_branch.png)
 
 ## Create a Pull Request
 
 Pull requests are useful before you merge your branch with the main branch. You can request a review from your colleagues and check for any conflicts with the main branch. After you pushed all the changes to your branch, you can go to the original GitHub repository and click on the pull request.
 
-![git pr](/assets/further_reading/create_pull_request.png)
+![git pr](../assets/further_reading/create_pull_request.png)
 
-![git pr info](/assets/further_reading/add_reviewers.png)
+![git pr info](../assets/further_reading/add_reviewers.png)
 
 ## Stay up-to-date with Honeycomb template repo
 

versioned_docs/version-3.2.x/quick_start.mdx

@@ -8,19 +8,19 @@ description: Quick start guide for Honeycomb
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 import CodeBlock from "@theme/CodeBlock";
-import cloneCodeButton from "/assets/clone-code-button.webp";
-import nvmrc from "/assets/nvmrc.png";
-import workflowPermissions from "/assets/workflow-permissions.png";
+import cloneCodeButton from "./assets/clone-code-button.webp";
+import nvmrc from "./assets/nvmrc.png";
+import workflowPermissions from "./assets/workflow-permissions.png";
 
 ## Creating Your Task Repository
 
 The Honeycomb repository is a template and serves as the starting point for all tasks. Creating your repository from the template starts your project with the same directory structure and files as an existing repository.
 
 1. Go to the [Honeycomb repository](https://github.com/brown-ccv/honeycomb)
 2. Click on `Use this template` and select `Create a new repository`.
-   ![Use this template](/assets/template_0.png)
+   ![Use this template](./assets/template_0.png)
 3. Enter the owner, name, and description of your repository and click on `Create repository from template`.
-   ![Create repository](/assets/template_1.png)
+   ![Create repository](./assets/template_1.png)
    :::note
    We recommend creating a public repository and leaving `Include all branches` unchecked
    :::
@@ -100,7 +100,7 @@ See [Prerequisites](prerequisites) for more information about these programs.
 
 1. Run Powershell as an admin from the start menu
 
-   ![Powershell admin launcher](/assets/powershell_admin.png)
+   ![Powershell admin launcher](./assets/powershell_admin.png)
 
 2. Navigate to the root directory of your cloned repository
 3. Paste the following command and follow the prompts to install the listed programs: