added contribute to doc

guides/contribute/index.rst

@@ -0,0 +1,110 @@
+.. _upsidedownlabs_contribute:
+
+Contribute to Documentation
+#############################
+
+This guide outlines the process for contributing to our documentation.
+
+Prerequisites
+=============
+
+- .. raw:: html
+
+     <a href="https://www.python.org/downloads/" target="_blank">Python</a>
+- .. raw:: html
+
+     <a href="https://git-scm.com/downloads" target="_blank">Git</a>
+
+Setup Steps
+==================
+
+1. Clone the repository:
+
+   .. code-block:: bash
+
+      git clone https://github.com/upsidedownlabs/upsidedownlabs.github.io.git
+
+
+2. Navigate to the cloned directory:
+
+   .. code-block:: bash
+
+      cd upsidedownlabs.github.io
+
+3. Creating virtual environment 
+
+   - Windows:
+
+   .. code-block:: bash
+
+      py -m venv myenv
+      myenv\Scripts\activate
+
+   - Linux:
+
+   .. code-block:: bash
+
+      python3 -m venv myenv
+      source myenv/bin/activate
+   
+4. Install dependencies:
+
+   .. code-block:: bash
+
+      pip install -r requirements.txt
+
+
+
+
+For Windiows
+======================
+
+1. Install Python from the official website if not already installed.
+2. Build the documentation:
+
+   .. code-block:: bash
+
+      sphinx-autobuild <source-dir> <output-dir>
+   .. warning::
+      The source directory and output directory must be different.
+
+   Example:
+
+   .. code-block:: bash
+
+      sphinx-autobuild . ../build/html
+
+   
+
+.. note::
+
+   Run this command if recent updates are not visible, this will clean the cache memory and rebuild the documentation.
+
+   .. code-block:: bash
+
+      .\make.bat clean
+
+Linux-Specific Steps
+====================
+
+1. Ensure Python is installed.
+2. Build the documentation:
+
+   .. code-block:: bash
+
+      make livehtml
+
+Making Changes
+==============
+
+1. Locate the relevant ``.rst`` files in the repository.
+2. Make your desired edits.
+3. Save the files to see live changes on your local server.
+
+.. note::
+
+   Run this command if recent updates are not visible, this will clean the cache memory and rebuild the documentation.
+
+   .. code-block:: bash
+
+      make clean

guides/index.rst

@@ -29,7 +29,15 @@ In this section, you'll find easy-to-follow guides that will help you while usin
 .. toctree::
    :hidden:
    :maxdepth: 1
+   :caption: Hardware Guides
 
    usage-guides/skin-preparation/index
    usage-guides/using-bioamp-bands/index
-   usage-guides/using-gel-electrodes/index
+   usage-guides/using-gel-electrodes/index
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Contribution Guide
+
+   contribute/index

software/bioamp_visualizer_technical_doc/index.rst

@@ -117,18 +117,19 @@ Technical Capabilities
 - **Signal Recording:** Users can record the data collected from the Arduino. This functionality allows for the preservation of real-time data for later analysis.
 - **CSV File Export:** Data from all channels will be exported to a CSV file. This feature is useful for detailed analysis and for research purposes. The CSV export includes comprehensive data from all channels, facilitating easy examination of the recorded data.
 
-
 Technologies Used
 *****************
 
 HTML 
 =====
+
 **Purpose**: HTML provides the foundational structure for web pages. It uses elements such as headings, paragraphs, links, images, and forms to define the content and layout of a webpage.
 
 **Role in our Project**: HTML is used to create the layout of our web application, including the navigation bar, modals, buttons, and containers (canvas) for charts. It defines the semantic structure and organizes the content, ensuring that all elements are properly placed and accessible.
 
 CSS 
 ========
+
 **Purpose**: CSS is used to style the visual presentation of HTML elements. It controls aspects such as layout, colors, fonts, spacing, and responsiveness.
 
 **Role in our Project**: CSS is responsible for the look and feel of our web application. It ensures that the design is visually appealing and responsive, adapting the layout to different screen sizes and devices.
@@ -157,6 +158,7 @@ Web Serial API
 
 Bootstrap
 =============
+
 **Purpose**: Bootstrap is a popular front-end framework that provides a collection of pre-designed CSS and JavaScript components. It simplifies the process of creating responsive and visually appealing web interfaces.
 
 **Role in our Project**: Bootstrap enhances the user interface by offering components like navigation bars, buttons and modals. It ensures that your application has a consistent look and feel and is responsive, adapting to various screen sizes. By importing Bootstrap CSS and JS, you leverage its components and styling to quickly build and customize your web application.
@@ -168,6 +170,7 @@ Bootstrap
 
 SmoothieCharts
 ===============
+
 **Purpose**: SmoothieCharts is a JavaScript library used for creating timeseries charts and real time data visualizations.
 
 **Role in our Project**: SmoothieCharts facilitates the dynamic visualization of bio potential signal data in our application. It allows for real-time updates to the chart as new data is added, providing an interactive and visually informative way to monitor the data.