From 95224d3496e29b8b50b69b49d79b77fbd6eebcb0 Mon Sep 17 00:00:00 2001 From: Niklas Haiden Date: Wed, 25 Dec 2024 12:32:12 +0100 Subject: [PATCH 1/3] docs: update start icon guide and add system requirements documentation --- docs/guides/start-icon.md | 7 +++++-- docs/reference/system-requirements.md | 11 +++++++++++ sidebars.ts | 2 +- 3 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 docs/reference/system-requirements.md diff --git a/docs/guides/start-icon.md b/docs/guides/start-icon.md index 7972260..215938c 100644 --- a/docs/guides/start-icon.md +++ b/docs/guides/start-icon.md @@ -6,12 +6,15 @@ description: How to change your start icon Updating your start icon in Aurora is a straight-forward process. You'll have access to both a sleek white version and a vibrant, colorful option to customize your experience. By default, the colorful version is selected. 1. Firstly, open the settings for the application launcher. This can be done by right clicking the application launcher icon on your taskbar. It will show a menu, select "Configure Application Launcher". + ![First step](/img/start-icon-change/screen-1.png) 2. In the screen that opens, click on the Aurora Logo Button and then click "Choose". This will open another window with lots of icons. - ![First step](/img/start-icon-change/screen-2.png) + + ![Second step](/img/start-icon-change/screen-2.png) 3. Last step: In the dropdown on the left, select "**All icons**" from the list. Then type in "**distributor**" in the search / input field and you should see the two logos that are currently included by default with your Aurora installation. - ![First step](/img/start-icon-change/screen-3.png) + + ![Third step](/img/start-icon-change/screen-3.png) That's it! You've successfully changed your icon. Also, you can also select custom icons here if you search for them via the file picker. 😉 (Click on the browse button on the bottom left). diff --git a/docs/reference/system-requirements.md b/docs/reference/system-requirements.md new file mode 100644 index 0000000..ccafe5e --- /dev/null +++ b/docs/reference/system-requirements.md @@ -0,0 +1,11 @@ +--- +title: Aurora System Requirements +description: System requirements to comofortably use Aurora +--- + +Using Aurora on your computer does not require any special sauce, but there are some system requirements you should be aware of. Other than the hard requirement of a 64-bit capable CPU (AMD, Intel) you should have at least the following system specifications on your Aurora Box: + +- A recent dual-core or higher multicore processor with at least 2 GHz +- 4 GB of RAM +- An SSD with at least 30GB of free space + diff --git a/sidebars.ts b/sidebars.ts index 47e79c9..4d91df3 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -31,7 +31,7 @@ const sidebars: SidebarsConfig = { type: "category", label: "Reference", collapsed: false, - items: ["reference/example"], + items: ["reference/example", "reference/system-requirements"], }, ], }; From 92e11c9710ec5c28aba123efd6080f1756623e44 Mon Sep 17 00:00:00 2001 From: Niklas Haiden Date: Wed, 25 Dec 2024 12:33:30 +0100 Subject: [PATCH 2/3] fix: format docs --- docs/guides/start-icon.md | 6 +++--- docs/reference/system-requirements.md | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/guides/start-icon.md b/docs/guides/start-icon.md index 215938c..d6d7c39 100644 --- a/docs/guides/start-icon.md +++ b/docs/guides/start-icon.md @@ -6,15 +6,15 @@ description: How to change your start icon Updating your start icon in Aurora is a straight-forward process. You'll have access to both a sleek white version and a vibrant, colorful option to customize your experience. By default, the colorful version is selected. 1. Firstly, open the settings for the application launcher. This can be done by right clicking the application launcher icon on your taskbar. It will show a menu, select "Configure Application Launcher". - + ![First step](/img/start-icon-change/screen-1.png) 2. In the screen that opens, click on the Aurora Logo Button and then click "Choose". This will open another window with lots of icons. - + ![Second step](/img/start-icon-change/screen-2.png) 3. Last step: In the dropdown on the left, select "**All icons**" from the list. Then type in "**distributor**" in the search / input field and you should see the two logos that are currently included by default with your Aurora installation. - + ![Third step](/img/start-icon-change/screen-3.png) That's it! You've successfully changed your icon. Also, you can also select custom icons here if you search for them via the file picker. 😉 (Click on the browse button on the bottom left). diff --git a/docs/reference/system-requirements.md b/docs/reference/system-requirements.md index ccafe5e..de998d8 100644 --- a/docs/reference/system-requirements.md +++ b/docs/reference/system-requirements.md @@ -3,9 +3,8 @@ title: Aurora System Requirements description: System requirements to comofortably use Aurora --- -Using Aurora on your computer does not require any special sauce, but there are some system requirements you should be aware of. Other than the hard requirement of a 64-bit capable CPU (AMD, Intel) you should have at least the following system specifications on your Aurora Box: +Using Aurora on your computer does not require any special sauce, but there are some system requirements you should be aware of. Other than the hard requirement of a 64-bit capable CPU (AMD, Intel) you should have at least the following system specifications on your Aurora Box: - A recent dual-core or higher multicore processor with at least 2 GHz - 4 GB of RAM - An SSD with at least 30GB of free space - From 87097b931f56fbc31b8060faed7c131c2d37d83e Mon Sep 17 00:00:00 2001 From: Niklas Haiden Date: Wed, 25 Dec 2024 12:37:01 +0100 Subject: [PATCH 3/3] docs: enhance system requirements documentation with SSD explanation --- docs/reference/system-requirements.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/reference/system-requirements.md b/docs/reference/system-requirements.md index de998d8..f68f03a 100644 --- a/docs/reference/system-requirements.md +++ b/docs/reference/system-requirements.md @@ -7,4 +7,8 @@ Using Aurora on your computer does not require any special sauce, but there are - A recent dual-core or higher multicore processor with at least 2 GHz - 4 GB of RAM -- An SSD with at least 30GB of free space +- An SSD with at least 30GB of free space to have space for now and future updates +
+> Why an SSD for the install? + +An HDD will work too but updates and other I/O heavy operations you might do when computing will suffer greatly and will drastically decrease your experience working with Aurora or any other OS in general. \ No newline at end of file