Merge branch 'main-docs' into major-documentation

# Conflicts:
#	activity_browser/docs/wiki/Databases.md
#	activity_browser/docs/wiki/Getting-Started.md

Author: mrvisscher

.github/ISSUE_TEMPLATE/beta_report.yml

@@ -0,0 +1,50 @@
+name: Activity Browser 3 Beta
+description: File a bug report or feature request.
+labels: ["beta"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to test the Activity Browser 3 Beta! Please fill out the following form to report a bug or request a feature. If you are reporting a bug, please make sure to include as much information as possible to help us reproduce the issue.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What do you want to report?
+      description: Also tell us, what did you expect to happen? You can share relevant files (e.g. screenshots/databases) here too.
+      placeholder: Tell us what happened
+    validations:
+      required: true
+  - type: textarea
+    id: errors
+    attributes:
+      label: Relevant errors
+      description: Please copy and paste any relevant errors from the terminal.
+      placeholder: This will be automatically formatted into code, so no need to worry about the formatting.
+      render: python
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Please specify the version of the Activity Browser you are using.
+      placeholder: e.g. 3.0.0b940
+  - type: dropdown
+    id: distribution
+    attributes:
+      label: Installation method
+      multiple: false
+      options:
+        - PyPI (pip)
+        - Anaconda (conda)
+      default: 0
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      multiple: false
+      options:
+        - Windows 10
+        - Windows 11
+        - MacOS (Apple Silicon)
+        - MacOS (Intel)
+        - Linux/Other (please specify above)
+      default: 1

activity_browser/docs/wiki/Installation-Guide.md

@@ -1,108 +1,103 @@
-## Quick Installation
-<details><summary><b>Familiar with Conda already? Do a quick install</b></summary>
+## Introduction
+Thank you for showing interesting in the Beta for Activity Browser 3.0. This release has been a year in the making and we're happy to 
+show of the hard work that's been put in and get it to a level where we're happy to show it to the wider public. Most notably AB3 will
+support Brightway25 and multifunctionality. But there have also been a lot of changes to the look and experience of the Activity Browser.
 
-You can install and start the activity-browser like this:
-1. Install [Miniconda](https://docs.anaconda.com/miniconda/#miniconda-latest-installer-links).
-2. ```bash 
-   conda create -n ab -c conda-forge activity-browser
-   conda activate ab
-   activity-browser
-   ```
-</details>
+Making so many changes inevitably also comes with creating a lot of bugs. We have tried to catch as may of them as we could, but in the 
+end noone is better at finding bugs than you, our users, are. We invite you to install the Activity Browser 3.0 Beta and break it in as 
+many ways as you possibly can. As long as you report the bugs you find back to us, so we can fix them.
 
-## The Anaconda package manager
-Skip this step if you already have a working installation of Anaconda or Miniconda, but make sure to keep your 
-conda installation up-to-date: `conda update -n base conda`.
+Thank you for your help, and enjoy the new Activity Browser!
 
-You need the python package manager [Anaconda](https://anaconda.org) to install Activity Browser.
-Anaconda is somewhat like an app-store for python programs.
-You can install the full [Anaconda user interface (navigator)](https://www.anaconda.com/download/success) 
-or just the minimal command-line installer,
-[Miniconda](https://docs.anaconda.com/miniconda/#miniconda-latest-installer-links).
-If needed, see also the 
-[conda user guide](https://docs.conda.io/projects/conda/en/latest/user-guide/index.html) 
-or the 
-[Conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf).
+> [!IMPORTANT] 
+> This is a **beta installation**. As always use of the Activity Browser is **at your own risk**, but take extra care with this installation. Back-up critical projects before opening them. 
 
-- Install the Anaconda manager of your choice from the above options.
-- Start `Anaconda Prompt` from the start menu.
-  - This is a terminal window with `conda`, you will need this prompt for all next steps. 
+## Distributions on PyPI and Anaconda
+The Activity Browser 3 Beta is available both on [PyPI]() and [Anaconda](). Because not all necessary libraries are available on Anaconda
+right now you need to do an extra `pip install` inside your Conda environment. 
 
-## Add the conda-forge channel
-Open an Anaconda prompt window and type the following (and `Enter`):
-```bash
-conda config --prepend channels conda-forge
+#### Quick-Install PyPI
+```
+pip install activity-browser
 ```
 
-<details><summary><b>More information about this step</b></summary>
+#### Quick-Install Anaconda
+```
+conda create -n ab_beta -c conda-forge lca::activity-browser
+conda activate ab_beta
+pip install PySide6
+```
 
-Activity Browser has many dependencies that are managed by 
-[conda-forge](https://conda.io/docs/user-guide/tasks/manage-channels.html).
-By adding the channel you can install python packages from there.
+For more elaborate installing instructions check out the page below for both [installing from PyPI](#installing-from-pypi) and [installing from Anaconda](#installing-from-anaconda).
 
-The line above means:
-- `conda`: a command for conda
-- `config`: change something in the configuration (settings) of `conda`
-- `--prepend channels`: in the channels from which conda can install things, add to the top (prepend)
-- `conda-forge`:  the channel name
-</details>
+## Installing from PyPI
+Installing from the Python Package Index (PyPI) can be done using the standard `pip` command. We strongly recommended installing the
+Activity Browser into a separate [virtual environment](https://realpython.com/python-virtual-environments-a-primer/)
 
-## Creating an environment and Installing Activity Browser
-Next, we create a python environment, in which we install Activity Browser 
+First make sure you have Python installed on your PC by entering the following command into your terminal or command prompt.
 
-```bash
-conda create -n ab -c conda-forge activity-browser
 ```
+python --version
+```
+If you get an error please install Python [using their install instructions](https://www.python.org/downloads/).
 
-> [!NOTE]
-> Installing Activity Browser can take some time, this depends on the speed of your internet connection and computer.
+### Creating a virtual environment
+Firstly, create a directory for your virtual environments, such as C:/Users/me/virtualenvs/. Then create a virtual environment in that 
+location using the following command:
+```
+python -m venv C:/Users/me/virtualenvs/ab-beta
+```
+Afterwards, you need to activate the virtual environment, which differs between operating systems and shells. Using Window Command Prompt
+activate the environment using this command:
+```
+C:\Users\me\virtualenvs\ab-beta\Scripts\activate.bat
+```
+For a full overview of activation commands, [check out the documentation here](https://docs.python.org/3/library/venv.html#how-venvs-work)
 
-<details><summary><b>More information about this step</b></summary>
+### Activity Browser Beta installation
+After creating the virtual environment, installing the Beta should be as simple as using the following command:
+```
+pip install activity-browser
+```
 
-We create a separate environment, this allows Activity Browser to work with the specific versions of other libraries 
-it needs without interfering with other python packages.
+### Launching the Activity Browser
+The Activity Browser can then be launched like so:
+```
+activity-browser
+```
 
-The line above means:
-- `conda`: a command for conda
-- `create -n ab`: create a new e**n**vironment (`-n`) with the name `ab`
-- `-c conda-forge`: from the **c**hannel (`-c`) `conda-forge`
-- `activity-browser`: install the package `activity-browser`
+## Installing from Anaconda
+First make sure you have Conda installed
 
-You can have as many environments as you like, you can also install different versions of Activity Browser 
-in different environments, for example for different [plugins](Plugins), or just for using different version of 
-Activity Browser. 
+```
+conda --version
+```
 
-All environments will have access to the same projects and databases in Activity Browser. 
+If you get an error, please download and install miniconda from anaconda.com https://www.anaconda.com/download/success
 
-</details>
+### Activity Browser Beta installation
+Next we're going to create a new environment for the Activity Browser Beta release.
 
-## Activating and running Activity Browser
-To run Activity Browser, you need to activate your environment with
-```bash
-conda activate ab
 ```
-
-And then run activity browser 
-with.
-```bash
-activity-browser
+conda create -n ab_beta -c conda-forge lca::activity-browser
 ```
 
-Congratulations! You've started Activity Browser for the first time!
+This will go through a few steps, some of which like `solving environment` may take a while. After installation has finished you can
+activate the environment like so:
 
-Every time you want to start Activity Browser, you need to start an anaconda prompt 
-and do `conda activate ab` and then `activity browser`.
+```
+conda activate ab_beta
+```
 
-## Updating Activity Browser
-We recommend to regularly update Activity Browser to receive new features & bugfixes. 
-These commands will update the Activity Browser and all of its dependencies in the conda environment called `ab`.
+### PySide6 installation
+We will need to install `PySide6` from a different source, as the fully functional version is not available on anaconda.
 
-```bash
-conda activate ab
-conda update activity-browser
+```
+pip install PySide6
 ```
 
-> [!IMPORTANT]
-> If you currently have a version <u>below</u> `2.10.0`, please consult 
-> [this guide](https://github.com/LCA-ActivityBrowser/activity-browser/discussions/1049)
-> to update.
+### Launching the Activity Browser
+Launch the Activity Browser like you would normally
+```
+activity-browser
+```

docs/.gitignore

@@ -0,0 +1,6 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+Gemfile.lock

docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: page
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/Gemfile

@@ -0,0 +1,34 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.4.1"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", "~> 232", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+gem "jekyll-remote-theme"

docs/_config.yml

@@ -0,0 +1,66 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Activity Browser
+logo: "/assets/activitybrowser.png"
+email: your-email@example.com
+
+# Build settings
+remote_theme: just-the-docs/just-the-docs
+plugins:
+  - jekyll-feed
+  - jekyll-remote-theme
+
+callouts_level: quiet # or loud
+callouts:
+  highlight:
+    color: yellow
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: purple
+  warning:
+    title: Warning
+    color: red
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

docs/_includes/nav_footer_custom.html

@@ -0,0 +1,3 @@
+<footer class="site-footer">
+    See how <b>you</b> can contribute in our <a href="github.com/LCA-ActivityBrowser/activity-browser/blob/master/CONTRIBUTING.md">Contributing Guidelines</a>
+</footer>

docs/_includes/search_placeholder_custom.html

@@ -0,0 +1 @@
+Search the docs

docs/_sass/custom/custom.scss

@@ -0,0 +1,12 @@
+.image-container{
+  display: flex;
+  flex-direction: row;
+  gap: 20px;
+  margin-bottom: 20px;
+}
+
+@media (max-width: 500px){
+    .image-container{
+        flex-direction: column;
+    }
+}