From 4e0f6ce5df39fcee8905cc94c4d9ae2f572b0313 Mon Sep 17 00:00:00 2001 From: Wayne <5291640+ringoinca@users.noreply.github.com> Date: Mon, 28 Jul 2025 11:38:14 +0300 Subject: [PATCH] Docs update --- README.md | 2 +- docs/.vitepress/config.mts | 8 +++++++- docs/assets/logo-sq.svg | 19 +++++++++++++++++++ docs/user-guides/installation.md | 2 +- 4 files changed, 28 insertions(+), 3 deletions(-) create mode 100644 docs/assets/logo-sq.svg diff --git a/README.md b/README.md index 9c0f7ff..c09ca9d 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Open Archiver is built on a modern, scalable, and maintainable technology stack: ### Prerequisites - [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) -- A server or local machine with at least 2GB of RAM. +- A server or local machine with at least 4GB of RAM (2GB of RAM if you use external Postgres, Redis (Valkey) and Meilisearch instances). ### Installation diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 163486d..3e282a3 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,9 +1,15 @@ import { defineConfig } from 'vitepress'; export default defineConfig({ - title: 'Open Archiver Documentation', + title: 'Open Archiver', description: 'Official documentation for the Open Archiver project.', themeConfig: { + search: { + provider: 'local' + }, + logo: { + src: './assets/logo-sq.svg' + }, nav: [ { text: 'Home', link: '/' }, { text: 'User Guides', link: '/user-guides/email-providers/' } diff --git a/docs/assets/logo-sq.svg b/docs/assets/logo-sq.svg new file mode 100644 index 0000000..94c43f5 --- /dev/null +++ b/docs/assets/logo-sq.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/user-guides/installation.md b/docs/user-guides/installation.md index 6fd375b..3a8e6fd 100644 --- a/docs/user-guides/installation.md +++ b/docs/user-guides/installation.md @@ -5,7 +5,7 @@ This guide will walk you through setting up Open Archiver using Docker Compose. ## Prerequisites - [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your server or local machine. -- A server or local machine with at least 2GB of RAM. +- A server or local machine with at least 4GB of RAM (2GB of RAM if you use external Postgres, Redis (Valkey) and Meilisearch instances). - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed on your server or local machine. ## 1. Clone the Repository