Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
3901663
feat: atlas upgrading docs
RadNotRed Jun 23, 2025
fc8c56f
feat: atlas update docs
RadNotRed Jun 23, 2025
658bab0
Merge branch 'main' into v0.5.0
pencilnav Oct 17, 2025
ec575ec
feat(brand): add v0.5 wallpapers to branding.md
whallin Oct 19, 2025
03b61fd
feat: v0.5.0 docs rewrite
pencilnav Oct 19, 2025
b8b4941
Merge branch 'v0.5.0' of https://github.com/Atlas-OS/docs into v0.5.0
pencilnav Oct 19, 2025
99d8d3a
feat(brand): correct paths
whallin Oct 19, 2025
ccc482d
Merge branch 'v0.5.0' of https://github.com/Atlas-OS/docs into v0.5.0
whallin Oct 19, 2025
1a4ff45
fix: add metadata descriptions for pages
jacksyrm Oct 19, 2025
d55004e
fix: remove period for consistencies
jacksyrm Oct 19, 2025
49b0aa6
fix: spelling issues and general inconcistencies
jacksyrm Oct 19, 2025
de300d3
fix: typo in mkdocs.yml
pencilnav Oct 19, 2025
b0223de
fix: typo in msdl.md
pencilnav Oct 19, 2025
498f055
feat: faq, getting started
pencilnav Oct 20, 2025
796a841
fix: broken links and icons
pencilnav Oct 20, 2025
843c0e1
fix: hyperlinks
pencilnav Oct 20, 2025
5a6f59f
docs: update requirements.txt for mkdocs material insiders
pencilnav Oct 20, 2025
827b991
feat: updating AtlasOS page in FAQ
TheyCreeper Oct 27, 2025
108ad33
fix: small typos
kamild1996 Oct 21, 2025
da1d8d2
fix: re-add Media Creation Tool and update the steps, formatting and …
kamild1996 Oct 21, 2025
82eb283
docs: add back old faq
pencilnav Jan 4, 2026
eeee5b1
fix: broken links
pencilnav Jan 4, 2026
0927e78
Merge branch 'main' into v0.5.0
pencilnav Jan 4, 2026
eedb604
docs: fix docs wordings and links
pencilnav Jan 4, 2026
651671f
fix: invalid links, changes to mkdocs.yml
pencilnav Jan 4, 2026
cf1690c
fix: all broken links in mkdocs-serve
pencilnav Jan 4, 2026
fcf133a
fix; wrong link
pencilnav Jan 4, 2026
90b1f1a
rm: windows 10 downloads from install guide
pencilnav Jan 4, 2026
a52cfae
Merge branch 'v0.5.0' of https://github.com/Atlas-OS/docs into v0.5.0
pencilnav Jan 4, 2026
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
8 changes: 0 additions & 8 deletions base-requirements.txt

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/branding.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,30 @@ We make all our brand assets available to the public in various formats and size

## Wallpapers

### Atlas v0.5

#### Rev 1

=== "v0.5 Rev 1.0"
![preview-wallpaper-v0.4-rev1.0](assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.0.png){ width=830 loading=lazy }

<div style="text-align: center;" class="grid" markdown>
[:material-download: PNG 4:3 (3072x2304)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.0-4_3.png){ .card }
[:material-download: PNG 16:9 (3840x2160)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.0-16_9.png){ .card }
[:material-download: PNG 16:10 (3840x2400)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.0-16_10.png){ .card }
[:material-download: PNG 21:9 (5040x2160)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.0-21_9.png){ .card }
</div>

=== "v0.5 Rev 1.1"
![preview-wallpaper-v0.4-rev1.0](assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.1.png){ width=830 loading=lazy }

<div style="text-align: center;" class="grid" markdown>
[:material-download: PNG 4:3 (3072x2304)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.1-4_3.png){ .card }
[:material-download: PNG 16:9 (3840x2160)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.1-16_9.png){ .card }
[:material-download: PNG 16:10 (3840x2400)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.1-16_10.png){ .card }
[:material-download: PNG 21:9 (5040x2160)](https://gcore.jsdelivr.net/gh/Atlas-OS/branding@main/wallpapers/v0.5/rev-1/wallpaper-v0.5-rev1.1-21_9.png){ .card }
</div>

### Atlas v0.4

#### Rev 1
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: material/book-edit

# :material-book-edit: Contributing to the Atlas documentation

This page will cover how to modify and locally view the Atlas documentation. If you plan to contribute, we recommend reading the [Contribution Guidelines](contribution-guidelines.md) first!
This page will cover how to modify and locally view the Atlas documentation. If you plan to contribute, we recommend reading the [Contribution Guidelines](index.md) first!

--8<-- "contribution-guidelines.md:gitNotice"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ For transparency with users, we keep issues that affect the current release open
## :octicons-git-pull-request-24: How to make changes

!!! tip "Unsure if people like your change?"
Consider proposing the change to people in the [:simple-discord: Discord](https://discord.gg/atlasos) or [:octicons-issue-opened-16: GitHub issues](https://github.com/Atlas-OS/Atlas/issues) first.
Consider proposing the change to people in the [:simple-discord: Discord](https://discord.com/invite/atlasos) or [:octicons-issue-opened-16: GitHub issues](https://github.com/Atlas-OS/Atlas/issues) first.

Regardless, remember that it's okay to make mistakes. People will give feedback in your pull requests anyway; don't worry about it too much.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/playbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: custom/atlas

# :custom-atlas: Contributing to the Atlas Playbook

This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](contribution-guidelines.md) first!
This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](index.md) first!

--8<-- "contribution-guidelines.md:gitNotice"

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/testing/reporting-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Please report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/iss

### If it's from a GitHub branch...

Ideally, report to the `📘 ┃ playbook` channel under our [Discord's 'Development' category](../../general-faq/testing-nightly-builds.md). Otherwise, report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/issues). Ensure that you follow the issue template.
Ideally, report to the `📘 ┃ playbook` channel under our [Discord's 'Development' category](https://discord.com/invite/atlasos). Otherwise, report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/issues). Ensure that you follow the issue template.

### If it's a [preview from our Discord](../../general-faq/testing-nightly-builds.md)...
### If it's a [preview from our Discord](https://discord.com/invite/atlasos)...

Report to the designated `🧪 ┃ issue-reporting` forum channel under the 'Development' category.
4 changes: 2 additions & 2 deletions docs/contributing/testing/what-to-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ icon: material/test-tube

This page covers what we recommend in general alpha or release candidate build testing. If you find any problems, please look at [the reporting issues page](reporting-issues.md).

If you still need to set up a virtual machine, see the [Playbook contributing page](../playbook.md) for instructions. However, feel free to test it on real hardware, especially if it's a [release candidate](../../general-faq/testing-nightly-builds.md)!
If you still need to set up a virtual machine, see the [Playbook contributing page](../playbook.md) for instructions. However, feel free to test it on real hardware, especially if it's a [release candidate](../testing/reporting-issues.md)!

!!! note "Ensure what you test works on stock Windows first"
To reduce the amount of false reports, please verify that any issues encountered on Atlas do not happen in the same environment and configuration on unmodified Windows.
Expand Down Expand Up @@ -47,7 +47,7 @@ As Atlas supports Windows Update, consider testing the following that all make u
Consider testing local network features such as:

- Windows file sharing
- Enable with the [Atlas script](../../getting-started/post-installation/atlas-folder/general-configuration.md#file-sharing) first
- Enable with the [Atlas script](../../post-install/atlas-folder/configuration.md#file-sharing) first
- Ensure that it works on stock Windows
- Screencasting
- Remote Desktop
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/toolbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: material/toolbox

# :material-toolbox: Contributing to the Atlas Toolbox

This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](contribution-guidelines.md) first!
This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](index.md) first!

We presume you've already cloned the [`Atlas-OS/atlas-toolbox`](https://github.com/Atlas-OS/atlas-toolbox) repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ icon: material/shield

# :material-shield: How secure is AtlasOS?

**Atlas aims to be as secure as you want, including the ability to toggle Windows Defender, [mitigations](../getting-started/post-installation/atlas-folder/security.md#mitigations), and automatic Windows updates freely.**
**Atlas aims to be as secure as you want, including the ability to toggle Windows Defender, [mitigations](../../post-install/atlas-folder/security.md#mitigations), and automatic Windows updates freely.**

While knowing potential risks, we believe power users should be able to customize security and convenience. Atlas alerts users about the dangers of turning off security features. We alert you through pre-install configuration prompts, [documentation](../getting-started/post-installation/atlas-folder/security.md), and our Atlas folder scripts.
While knowing potential risks, we believe power users should be able to customize security and convenience. Atlas alerts users about the dangers of turning off security features. We alert you through pre-install configuration prompts, [documentation](../../post-install/atlas-folder/security.md), and our Atlas folder scripts.

Additionally, you can always change security post-install.

Expand All @@ -19,7 +19,7 @@ Regardless, Atlas aims to have similar parity with unmodified Windows' security

## :material-timeline-question: Legacy versions of Atlas

Versions of Atlas earlier than `v0.3` are now considered legacy and previously raised many security concerns. We **strongly recommend** that anyone on these Atlas versions [reinstall Windows and upgrade to the latest version](../getting-started/installation.md), as they are unsecure and unsupported.
Versions of Atlas earlier than `v0.3` are now considered legacy and previously raised many security concerns. We **strongly recommend** that anyone on these Atlas versions [reinstall Windows and upgrade to the latest version](../../getting-started/index.md), as they are unsecure and unsupported.

### Why was Atlas unsecure previously?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ icon: material/folder-question

If you wish to have the folder on your desktop, you should right-click on the folder and create a shortcut.

![The AtlasDesktop folder on an AtlasOS installation, which is located in the Windows folder](../assets/images/atlasdesktop-windows-folder.webp)
![The AtlasDesktop folder on an AtlasOS installation, which is located in the Windows folder](../../assets/images/atlasdesktop-windows-folder.webp)

## What about if I can't find AtlasDesktop?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ icon: material/bluetooth

**Yes, Bluetooth is fully functional on AtlasOS.**

If you're using AtlasOS and have not enabled [Automatic Driver Installation](../getting-started/post-installation/drivers/getting-started.md#want-driver-installation-updates-through-windows-update-instead), you will need to install the Bluetooth driver manually. Follow these steps to set up Bluetooth:
If you're using AtlasOS and have not enabled [Automatic Driver Installation](../../post-install/drivers/index.md#want-driver-installation-updates-through-windows-update-instead), you will need to install the Bluetooth driver manually. Follow these steps to set up Bluetooth:

1. If you've disabled Bluetooth, [enable Bluetooth services](../getting-started/post-installation/atlas-folder/advanced-configuration.md#services) in the Atlas folder.
1. If you've disabled Bluetooth, [enable Bluetooth services](../../post-install/atlas-folder/configuration.md#bluetooth) in the Atlas folder.

2. Install your Bluetooth driver. You can follow our [drivers guide](../getting-started/post-installation/drivers/others.md) for this.
2. Install your Bluetooth driver. You can follow our [drivers guide](../../post-install/drivers/others.md) for this.
- Most issues with Bluetooth are caused by installing improper drivers. Make sure to research and find the driver that is suited for your device.

3. Turn on Bluetooth and pair your device.

![The Atlas 'Bluetooth' configuration folder](../assets/images/bluetooth-script-folder.webp)
![The Atlas 'Bluetooth' configuration folder](../../assets/images/bluetooth-script-folder.webp)

If these steps did not resolve your issue, try researching further into the driver you should download for your system. These are almost always the cause and are not an issue directly with AtlasOS.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is a quick way to see your Windows build number and the Atlas Playbook vers
3. A window will appear showing your Windows version and OS Build number. Below the user name, you should also see the **Atlas Playbook version** installed (e.g., `Atlas Playbook v0.4.1`).

<figure markdown="span">
![Winver dialog showing Atlas Playbook version](../assets/images/winver-atlas-version.png)
![Winver dialog showing Atlas Playbook version](../../assets/images/winver-atlas-version.png)
<figcaption>Atlas Playbook v0.4.1 shown in the winver dialog</figcaption>
</figure>

Expand All @@ -33,7 +33,7 @@ You can also find detailed system information, including the Atlas Playbook vers
5. Further down, under the "Windows specifications" section, you'll find the base Windows Edition (e.g., Windows 11 Pro) and the Version number (e.g., 22H2).

<figure markdown="span">
![Windows Settings About page showing Atlas Playbook version under the device name](../assets/images/windows-settings-atlas-version.png)
![Windows Settings About page showing Atlas Playbook version under the device name](../../assets/images/windows-settings-atlas-version.png)
<figcaption>Atlas Playbook v0.4.1 shown in the Windows Settings About page</figcaption>
</figure>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ Once you find the setting:

## Step 5: Retry Windows Installation

After your computer restarts, attempt the Windows 11 installation step from the [Atlas Installation Guide](../getting-started/installation.md) again. The requirements check should now pass if TPM was the only issue.
After your computer restarts, attempt the Windows 11 installation step from the [Atlas Installation Guide](../../getting-started/index.md) again. The requirements check should now pass if TPM was the only issue.

If you continue to have problems, double-check your BIOS/UEFI settings and consult your hardware manufacturer's documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ description: How to fix my shortcuts showing up as .url files or without an icon

1. Right click the shortcut and click `Choose another app` under `Open With...`

![The Open With context menu](../assets/images/open-with-10.png)
![The Open With context menu](../../assets/images/open-with-10.png)

!!! failure "If there is no `Open With...` menu, double click the shortcut instead."

2. Choose **Internet Browser** and tick `Always use this app to open .url files`

![The Open With menu for a .url file](../assets/images/url-open-with.png)
![The Open With menu for a .url file](../../assets/images/url-open-with.png)

3. Press `OK`
=== ":material-microsoft: Windows 11"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For a working and supported AtlasOS system, you **must**:
1. Perform a clean installation of a compatible Windows version.
2. Apply the Atlas playbook immediately after the Windows setup.

[:link: Refer to the Installation Guide for supported Windows versions and steps](../getting-started/installation.md)
[:link: Refer to the Installation Guide for supported Windows versions and steps](../../getting-started/index.md)

## :material-file-document-outline: Will I lose my personal files and data?

Expand All @@ -33,4 +33,4 @@ If you are asking this question, it means you have **not** read or followed the

**Do not proceed further without consulting the guide:**

[:link: Atlas Installation Guide](../getting-started/installation.md)
[:link: Atlas Installation Guide](../../getting-started/index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ icon: material/apple

**If iTunes is not recognizing your Apple device, it's likely a driver issue. You can fix this by downloading and installing the Apple USB Drivers.**

If you're using Atlas and have not enabled [Automatic Driver Installation](../getting-started/post-installation/drivers/getting-started.md#want-driver-installation-updates-through-windows-update-instead), you will need to install the Apple USB driver manually.
If you're using Atlas and have not enabled [Automatic Driver Installation](../../post-install/drivers/index.md#want-driver-installation-updates-through-windows-update-instead), you will need to install the Apple USB driver manually.

## :material-package-down: Manual Installation

!!! tip
If you're experiencing significant issues with drivers, consider enabling [Automatic Driver Installation](../getting-started/post-installation/atlas-folder/general-configuration.md#automatic-updates) from the Atlas folder.
If you're experiencing significant issues with drivers, consider enabling [Automatic Driver Installation](../../post-install/atlas-folder/configuration.md#driver-updates) from the Atlas folder.

1. Download the latest Apple USB drivers from the [Microsoft Update Catalog](https://www.catalog.update.microsoft.com/Search.aspx?q=Apple%2C%20Inc.%20-%20USBDevice) that begins with a three-digit version number.

![You should only select the Apple USB driver that starts with a three-digit version](../assets/images/apple-driver-version.webp)
![You should only select the Apple USB driver that starts with a three-digit version](../../assets/images/apple-driver-version.webp)

2. Extract the downloaded zip file using 7-Zip or Explorer. Ignore any warnings that may appear.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ If you're experiencing issues with the Microsoft Store, these are unrelated to A
3. Paste in `9WZDNCRFJBMP` and click the tick button
4. Scroll down until you find the files starting with `Microsoft.WindowsStore`
5. Click on the one that has the highest version number and ends in `.msixbundle`
![msstoreappx](../assets/images/msstoreappx.webp)
![msstoreappx](../../assets/images/msstoreappx.webp)
6. Double-click the downloaded file, and click **Install**
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ If you want to start fresh with AtlasOS (effectively "resetting" your Atlas inst

**Follow the official Installation Guide for detailed steps:**

[:link: Atlas Installation Guide](../getting-started/installation.md)
[:link: Atlas Installation Guide](../../getting-started/index.md)

## :material-undo-variant: Just Want to Remove Atlas?

If your goal is simply to return to a standard version of Windows without AtlasOS, you should follow the guide for reverting Atlas, which also involves a clean Windows installation.

[:link: Reverting Atlas Guide](../getting-started/reverting-atlas.md)
[:link: Reverting Atlas Guide](../install-faq/reverting-atlas.md)
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ We often post announcements to the development Discord role when we need help te

These builds are different from the ones automatically built on our GitHub. Official development builds posted on our Discord are ready to be tested for feedback.

See ['Contributing to the Atlas Playbook'](../contributing/playbook.md) for more information on testing. :smile:
See ['Contributing to the Atlas Playbook'](../../contributing/playbook.md) for more information on testing. :smile:

![The Atlas Discord server's 'Channels & Role' page, cropped onto the 'Development' role](../assets/images/discord-development-role.webp)
![The Atlas Discord server's 'Channels & Role' page, cropped onto the 'Development' role](../../assets/images/discord-development-role.webp)
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We understand it can be frustrating to be on an older version. Unfortunately, ve

To ensure you have the best and most secure experience, we **strongly** recommend one of these options:

1. **Fresh Start with the Latest Atlas:** [Reinstall Windows and then install the newest version of AtlasOS.](../getting-started/installation.md) This is the best way to get all the current benefits.
2. **Return to Standard Windows:** [Reinstall a standard, unmodified version of Windows.](../getting-started/reverting-atlas.md)
1. **Fresh Start with the Latest Atlas:** [Reinstall Windows and then install the newest version of AtlasOS.](../../getting-started/index.md) This is the best way to get all the current benefits.
2. **Return to Standard Windows:** [Reinstall a standard, unmodified version of Windows.](../install-faq/reverting-atlas.md)

We know reinstalling can be a bit of work, but it's the safest path forward from these older versions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ If you wish to move to a newer version of Windows (e.g., Windows 11) and continu

**Follow the official Installation Guide** to reinstall the desired Windows version (e.g., Windows 11) and apply the corresponding AtlasOS playbook. Remember to back up your personal data beforehand.

[:link: Atlas Installation Guide](../getting-started/installation.md)
[:link: Atlas Installation Guide](../../getting-started/index.md)

This process ensures a clean slate for both the new Windows installation and the Atlas modifications, minimizing the risk of conflicts and ensuring a stable, supported system.
Loading