docs: Added quick start, installation

.prettierignore

@@ -0,0 +1 @@
+docs/

CONTRIBUTING.md

@@ -12,7 +12,7 @@ Fork the Biscuit repository and clone locally.
 git clone http://github.com/tomlin7/biscuit
 ```
 
-In the root directory, run `poetry install`. Try to launch biscuit from source with `poetry run biscuit` and make sure everything looks good.
+In the root directory, run `poetry install`. Try to launch biscuit from source with simply `biscuit` (or `poetry run biscuit`) and make sure everything looks good.
 
 > [!IMPORTANT]
 > Linux distros require some prerequisites to be installed prior to the pip installation

README.md

@@ -28,6 +28,15 @@ pip install biscuit-editor
 
 Try running `biscuit --version` in your terminal to check if the installation was successful.
 
+> [!IMPORTANT]
+> Linux distros require some prerequisites to be installed prior to the pip installation
+>
+> ```bash
+>  sudo apt install fontconfig libfontconfig1 libfontconfig1-dev \
+>    cmake cmake-data extra-cmake-modules build-essential
+>  python -m pip install scikit-build
+> ```
+
 ### Standalone Builds
 
 - Grab the latest stable build from [**releases page**](https://github.com/tomlin7/Biscuit/releases)
@@ -37,7 +46,7 @@ For compiling from source code, please check the [installation guide](https://gi
 
 ## Contributing ❤️
 
-Your contributions are valuable and very much appreciated!
+Your contributions are very much appreciated!
 Have a peek at the [contributing guide](https://github.com/tomlin7/Biscuit/blob/main/CONTRIBUTING.md) for a quick tour on project structure and to setup the environment. To contribute a new extension, check the [extension docs](https://github.com/tomlin7/biscuit-extensions).
 
 <a href="https://github.com/tomlin7/biscuit/graphs/contributors">

docs/README.md

@@ -0,0 +1,51 @@
+# Biscuit Documentation
+
+`docs/` contains the documentation for Biscuit. The documentation is written in Markdown and is rendered using [MkDocs](https://www.mkdocs.org/). Site uses the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
+
+## Building the documentation
+
+If you have Poetry installed, you can install the dependencies for the documentation by running:
+
+```bash
+poetry install --with docs
+```
+
+Then you can serve the documentation locally by running:
+
+```bash
+poetry run mkdocs serve
+```
+
+Building the documentation can be done by running:
+
+```bash
+poetry run mkdocs build
+```
+
+The documentation will be built in the `site` directory.
+
+If you don't have Poetry installed, you can install the dependencies by running:
+
+```bash
+pip install mkdocs mkdocs-material mkdocstrings-python
+```
+
+Then you can serve the documentation locally by running:
+
+```bash
+mkdocs serve
+```
+
+Building the documentation can be done by running:
+
+```bash
+mkdocs build
+```
+
+## Contributing
+
+If you want to contribute to the documentation, first check issue [#418](https://github.com/tomlin7/biscuit/issues/418) to see if there are any open issues. You can also create a new issue if you find something that needs to be fixed or added to the documentation.
+
+If you want to add a new page, create a new Markdown file in the `docs` directory and add it to the `nav` section in the `mkdocs.yml` file. If you want to edit an existing page, find the corresponding Markdown file in the `docs` directory and make your changes. Then create a pull request with your changes.
+
+If you want to add a new section to the documentation, create a new directory in the `docs` directory and add a new Markdown file to that directory. Then add the new directory and file to the `nav` section in the `mkdocs.yml` file. If you want to edit an existing section, find the corresponding directory in the `docs` directory and make your changes. Then create a pull request with your changes.

docs/getting-started/installation.md

@@ -0,0 +1,27 @@
+## Installation
+
+Recommended way to install Biscuit is via pip:
+
+```bash
+pip install biscuit-editor
+```
+
+Try running `biscuit --version` in your terminal to check if the installation was successful.
+
+!!! Info
+    Linux distros require some prerequisites to be installed prior to the pip installation
+    ```bash
+     sudo apt install fontconfig libfontconfig1 libfontconfig1-dev \
+       cmake cmake-data extra-cmake-modules build-essential
+     python -m pip install scikit-build
+    ```
+
+For compiling from source code, please check the [installation guide](https://github.com/tomlin7/biscuit/tree/main/scripts).
+### Alternative Installation Methods
+
+1. **Standalone Builds**: 
+   - Grab the latest stable build from [**releases page**](https://github.com/tomlin7/biscuit/releases)
+   - For unstable nightly builds, check the [GitHub actions](https://github.com/tomlin7/biscuit/actions)
+
+2. **Compiling from source**: 
+   For instructions on compiling from source code, please refer to the [installation guide](https://github.com/tomlin7/biscuit/tree/main/scripts/README.md).

docs/getting-started/quick-start.md

@@ -0,0 +1,54 @@
+# Quick Start
+
+This guide will help you set up Biscuit in 5 minutes. 
+
+## Installation
+
+Recommended way to install Biscuit is via pip:
+
+```bash
+pip install biscuit-editor
+```
+
+Try running `biscuit --version` in your terminal to check if the installation was successful.
+
+See the [installation guide](installation.md) for more detailed instructions on installing Biscuit.
+
+## Starting Biscuit
+
+Next, you can start using Biscuit by simply running:
+
+```bash
+biscuit
+```
+
+You can also open a directory/file directly by running:
+
+```bash
+biscuit path/to/folder
+```
+
+This will open the specified directory/file in Biscuit.
+For more options, run `biscuit --help` or check the [CLI reference](../cli.md).
+
+## User Interface
+
+Biscuit's user interface is designed to be minimalistic and more focused on the content. When you open Biscuit you'll see a **welcome tab** with quick access to common actions. At the bottom, you'll find the status bar which also has buttons to show/hide the sidebar views and terminal. Buttons on the left and right will toggle the sidebars of corresponding sides. 
+
+![welcome](img/welcome.png)
+
+To view all commands available in Biscuit, press `Ctrl+Shift+P` or the command palette button from titlebar. This will open the command palette where you can search for commands. The titlebar contains a simple menu bar and a search bar which can be used to search for files in the opened workspace.
+
+### Terminals
+
+Biscuit can have multiple integrated terminals running in the editor. You can open a terminal by clicking on the panel toggle on the status bar or by pressing Ctrl+`. To open more terminals, click on the plus icon and pick from the options (depending on the OS cmd, bash, powershell, etc. will be available).
+
+### Extensions
+To Browse extensions click on **Extensions** from welcome tab or the extensions button on the status bar. You can install recommended extensions and access them instantly as they are installed. 
+
+### Git
+Biscuit has built-in Git support, so you can manage your Git repositories directly from the editor. Click on the Source Control icon on the status bar to open the Git view.
+
+## Next Steps
+
+- [Configure Biscuit](configuration.md)

docs/cli.md → docs/usage/cli.md

@@ -1,3 +1,6 @@
 # CLI
 
 Biscuit provides a command line interface (CLI) to interact with the main application. The CLI is a powerful tool that allows you to perform a wide range of operations, such as managing extensions, files, and settings.
+
+
+### TODO: Add CLI documentation

mkdocs.yml

@@ -48,20 +48,12 @@ extra_javascript:
   - javascripts/extra.js
 nav:
   - Home: index.md
-  - CLI: cli.md
-  # - Getting Started:
-  #     - Installation: getting-started/installation.md
-  #     - Quick Start: getting-started/quick-start.md
-  # - About: about.md
-  # - Installation: installation.md
-  # - Usage:
-  #   - Quick Start: usage/quick-start.md
+  - Getting Started:
+      - Quick Start: getting-started/quick-start.md
+      - Installation: getting-started/installation.md
   #   - Configuration: usage/configuration.md
-  #   - Customization: usage/customization.md
-  # - Features:
-  #   - Code Editor: features/code-editor.md
-  #   - Language Support: features/language-support.md
-  #   - Extensions: features/extensions.md
+  - Usage:
+      - CLI: usage/cli.md
   - API Reference:
       - App: api/app.md
       - CLI: api/cli.md