Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update start icon guide and add system requirements documentation #14

Merged
merged 3 commits into from
Dec 26, 2024
Merged

docs: update start icon guide and add system requirements documentation #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
95224d3
docs: update start icon guide and add system requirements documentation
NiHaiden Dec 25, 2024
92e11c9
fix: format docs
NiHaiden Dec 25, 2024
87097b9
docs: enhance system requirements documentation with SSD explanation
NiHaiden Dec 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/guides/start-icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
14 changes: 14 additions & 0 deletions docs/reference/system-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remember: adding this information here means you are going to support it. If someone with a 3rd gen dual core with 4GB or RAM gets mad at you, they will feel like they're in the right

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm you are not wrong but what I should I put there instead? @nicknamenamenick suggested to write some basic system requirements but I'm not exactly sure what to target here.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should write out minimal requirements and recommended ones: mininmal ones just so people can know how little aurora can take up, and recommended for actually supported hardware

- 4 GB of RAM
- An SSD with at least 30GB of free space to have space for now and future updates
<hr/>
> 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.
2 changes: 1 addition & 1 deletion sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const sidebars: SidebarsConfig = {
type: "category",
label: "Reference",
collapsed: false,
items: ["reference/example"],
items: ["reference/example", "reference/system-requirements"],
},
],
};
Expand Down
Loading