Merge pull request #466 from timoa/fix/docs-markdown-lint

📚 chore(docs): fix Markdown lint issues in the docs

docs/architecture/README.md

@@ -1,4 +1,4 @@
-## Perplexica's Architecture
+# Perplexica's Architecture
 
 Perplexica's architecture consists of the following key components:
 

docs/architecture/WORKING.md

@@ -1,4 +1,4 @@
-## How does Perplexica work?
+# How does Perplexica work?
 
 Curious about how Perplexica works? Don't worry, we'll cover it here. Before we begin, make sure you've read about the architecture of Perplexica to ensure you understand what it's made up of. Haven't read it? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md).
 
@@ -10,10 +10,10 @@ We'll understand how Perplexica works by taking an example of a scenario where a
 4. After the information is retrieved, it is based on keyword-based search. We then convert the information into embeddings and the query as well, then we perform a similarity search to find the most relevant sources to answer the query.
 5. After all this is done, the sources are passed to the response generator. This chain takes all the chat history, the query, and the sources. It generates a response that is streamed to the UI.
 
-### How are the answers cited?
+## How are the answers cited?
 
 The LLMs are prompted to do so. We've prompted them so well that they cite the answers themselves, and using some UI magic, we display it to the user.
 
-### Image and Video Search
+## Image and Video Search
 
 Image and video searches are conducted in a similar manner. A query is always generated first, then we search the web for images and videos that match the query. These results are then returned to the user.

docs/installation/NETWORKING.md

@@ -10,27 +10,27 @@ This guide will show you how to make Perplexica available over a network. Follow
 
 3. Stop and remove the existing Perplexica containers and images:
 
-```
+    ```bash
-docker compose down --rmi all
+    docker compose down --rmi all
-```
+    ```
 
 4. Open the `docker-compose.yaml` file in a text editor like Notepad++
 
 5. Replace `127.0.0.1` with the IP address of the server Perplexica is running on in these two lines:
 
-```
+    ```bash
-args:
+    args:
       - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
       - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
-```
+    ```
 
 6. Save and close the `docker-compose.yaml` file
 
 7. Rebuild and restart the Perplexica container:
 
-```
+    ```bash
-docker compose up -d --build
+    docker compose up -d --build
-```
+    ```
 
 ## macOS
 
@@ -38,37 +38,37 @@ docker compose up -d --build
 
 2. Navigate to the directory with the `docker-compose.yaml` file:
 
-```
+    ```bash
-cd /path/to/docker-compose.yaml
+    cd /path/to/docker-compose.yaml
-```
+    ```
 
 3. Stop and remove existing containers and images:
 
-```
+    ```bash
-docker compose down --rmi all
+    docker compose down --rmi all
-```
+    ```
 
 4. Open `docker-compose.yaml` in a text editor like Sublime Text:
 
-```
+    ```bash
-nano docker-compose.yaml
+    nano docker-compose.yaml
-```
+    ```
 
 5. Replace `127.0.0.1` with the server IP in these lines:
 
-```
+    ```bash
-args:
+    args:
       - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
       - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
-```
+    ```
 
 6. Save and exit the editor
 
 7. Rebuild and restart Perplexica:
 
-```
+    ```bash
-docker compose up -d --build
+    docker compose up -d --build
-```
+    ```
 
 ## Linux
 
@@ -76,34 +76,34 @@ docker compose up -d --build
 
 2. Navigate to the `docker-compose.yaml` directory:
 
-```
+    ```bash
-cd /path/to/docker-compose.yaml
+    cd /path/to/docker-compose.yaml
-```
+    ```
 
 3. Stop and remove containers and images:
 
-```
+    ```bash
-docker compose down --rmi all
+    docker compose down --rmi all
-```
+    ```
 
 4. Edit `docker-compose.yaml`:
 
-```
+    ```bash
-nano docker-compose.yaml
+    nano docker-compose.yaml
-```
+    ```
 
 5. Replace `127.0.0.1` with the server IP:
 
-```
+    ```bash
-args:
+    args:
       - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api
       - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001
-```
+    ```
 
 6. Save and exit the editor
 
 7. Rebuild and restart Perplexica:
 
-```
+    ```bash
-docker compose up -d --build
+    docker compose up -d --build
-```
+    ```

docs/installation/UPDATING.md

@@ -6,23 +6,23 @@ To update Perplexica to the latest version, follow these steps:
 
 1. Clone the latest version of Perplexica from GitHub:
 
-```bash
+   ```bash
       git clone https://github.com/ItzCrazyKns/Perplexica.git
-```
+   ```
 
 2. Navigate to the Project Directory.
 
 3. Pull latest images from registry.
 
-```bash
+   ```bash
-docker compose pull
+   docker compose pull
-```
+   ```
 
 4. Update and Recreate containers.
 
-```bash
+   ```bash
-docker compose up -d
+   docker compose up -d
-```
+   ```
 
 5. Once the command completes running go to http://localhost:3000 and verify the latest changes.
 
@@ -30,9 +30,9 @@ docker compose up -d
 
 1. Clone the latest version of Perplexica from GitHub:
 
-```bash
+   ```bash
       git clone https://github.com/ItzCrazyKns/Perplexica.git
-```
+   ```
 
 2. Navigate to the Project Directory
 3. Execute `npm i` in both the `ui` folder and the root directory.