diff --git a/base-requirements.txt b/base-requirements.txt deleted file mode 100644 index 485465b8..00000000 --- a/base-requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -# https://github.com/ojacques/mkdocs-git-committers-plugin-2 -mkdocs-git-committers-plugin-2 - -# https://github.com/mkdocs/mkdocs-redirects -mkdocs-redirects - -# https://mkdocs-macros-plugin.readthedocs.io/en/stable/ -mkdocs-macros-plugin diff --git a/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.0.png b/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.0.png new file mode 100644 index 00000000..db4dc681 Binary files /dev/null and b/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.0.png differ diff --git a/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.1.png b/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.1.png new file mode 100644 index 00000000..5a8db7c7 Binary files /dev/null and b/docs/assets/brand/preview/wallpapers/v0.5/rev-1/preview-wallpaper-v0.5-rev1.1.png differ diff --git a/docs/branding.md b/docs/branding.md index 3a61a6fe..d80ca034 100644 --- a/docs/branding.md +++ b/docs/branding.md @@ -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 } + +
+ [: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 } +
+ +=== "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 } + +
+ [: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 } +
+ ### Atlas v0.4 #### Rev 1 diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md index b1b9beb7..8616b573 100644 --- a/docs/contributing/documentation.md +++ b/docs/contributing/documentation.md @@ -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" diff --git a/docs/contributing/contribution-guidelines.md b/docs/contributing/index.md similarity index 97% rename from docs/contributing/contribution-guidelines.md rename to docs/contributing/index.md index 1a25c482..43507e33 100644 --- a/docs/contributing/contribution-guidelines.md +++ b/docs/contributing/index.md @@ -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. diff --git a/docs/contributing/playbook.md b/docs/contributing/playbook.md index 2a352f9f..b0268838 100644 --- a/docs/contributing/playbook.md +++ b/docs/contributing/playbook.md @@ -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" diff --git a/docs/contributing/testing/reporting-issues.md b/docs/contributing/testing/reporting-issues.md index 367ab564..0d06316b 100644 --- a/docs/contributing/testing/reporting-issues.md +++ b/docs/contributing/testing/reporting-issues.md @@ -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. diff --git a/docs/contributing/testing/what-to-test.md b/docs/contributing/testing/what-to-test.md index abd073f2..bf197434 100644 --- a/docs/contributing/testing/what-to-test.md +++ b/docs/contributing/testing/what-to-test.md @@ -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. @@ -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 diff --git a/docs/contributing/toolbox.md b/docs/contributing/toolbox.md index a3219ff6..996ffca2 100644 --- a/docs/contributing/toolbox.md +++ b/docs/contributing/toolbox.md @@ -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. diff --git a/docs/general-faq/atlas-and-security.md b/docs/faq/general-faq/atlas-and-security.md similarity index 81% rename from docs/general-faq/atlas-and-security.md rename to docs/faq/general-faq/atlas-and-security.md index 69b5012f..d4792043 100644 --- a/docs/general-faq/atlas-and-security.md +++ b/docs/faq/general-faq/atlas-and-security.md @@ -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. @@ -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? diff --git a/docs/general-faq/atlas-folder-missing.md b/docs/faq/general-faq/atlas-folder-missing.md similarity index 91% rename from docs/general-faq/atlas-folder-missing.md rename to docs/faq/general-faq/atlas-folder-missing.md index ca932eb7..e68d99da 100644 --- a/docs/general-faq/atlas-folder-missing.md +++ b/docs/faq/general-faq/atlas-folder-missing.md @@ -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? diff --git a/docs/general-faq/bluetooth-compatibility.md b/docs/faq/general-faq/bluetooth-compatibility.md similarity index 60% rename from docs/general-faq/bluetooth-compatibility.md rename to docs/faq/general-faq/bluetooth-compatibility.md index 11f95d44..c7103894 100644 --- a/docs/general-faq/bluetooth-compatibility.md +++ b/docs/faq/general-faq/bluetooth-compatibility.md @@ -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. diff --git a/docs/general-faq/checking-atlas-version.md b/docs/faq/general-faq/checking-atlas-version.md similarity index 92% rename from docs/general-faq/checking-atlas-version.md rename to docs/faq/general-faq/checking-atlas-version.md index be5087e1..8239a639 100644 --- a/docs/general-faq/checking-atlas-version.md +++ b/docs/faq/general-faq/checking-atlas-version.md @@ -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`).
- ![Winver dialog showing Atlas Playbook version](../assets/images/winver-atlas-version.png) + ![Winver dialog showing Atlas Playbook version](../../assets/images/winver-atlas-version.png)
Atlas Playbook v0.4.1 shown in the winver dialog
@@ -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).
- ![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)
Atlas Playbook v0.4.1 shown in the Windows Settings About page
diff --git a/docs/general-faq/enabling-tpm.md b/docs/faq/general-faq/enabling-tpm.md similarity index 95% rename from docs/general-faq/enabling-tpm.md rename to docs/faq/general-faq/enabling-tpm.md index f3e7b57d..7d297db5 100644 --- a/docs/general-faq/enabling-tpm.md +++ b/docs/faq/general-faq/enabling-tpm.md @@ -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. \ No newline at end of file diff --git a/docs/general-faq/fifa-and-eafc-not-launching.md b/docs/faq/general-faq/fifa-and-eafc-not-launching.md similarity index 100% rename from docs/general-faq/fifa-and-eafc-not-launching.md rename to docs/faq/general-faq/fifa-and-eafc-not-launching.md diff --git a/docs/general-faq/game-url-files.md b/docs/faq/general-faq/game-url-files.md similarity index 84% rename from docs/general-faq/game-url-files.md rename to docs/faq/general-faq/game-url-files.md index 37a8d240..1d545ca7 100644 --- a/docs/general-faq/game-url-files.md +++ b/docs/faq/general-faq/game-url-files.md @@ -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" diff --git a/docs/general-faq/installation-data-loss.md b/docs/faq/general-faq/installation-data-loss.md similarity index 94% rename from docs/general-faq/installation-data-loss.md rename to docs/faq/general-faq/installation-data-loss.md index ac8849aa..ad6fcee3 100644 --- a/docs/general-faq/installation-data-loss.md +++ b/docs/faq/general-faq/installation-data-loss.md @@ -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? @@ -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) \ No newline at end of file +[:link: Atlas Installation Guide](../../getting-started/index.md) \ No newline at end of file diff --git a/docs/general-faq/itunes-compatibility.md b/docs/faq/general-faq/itunes-compatibility.md similarity index 69% rename from docs/general-faq/itunes-compatibility.md rename to docs/faq/general-faq/itunes-compatibility.md index 0d434c4a..42e81603 100644 --- a/docs/general-faq/itunes-compatibility.md +++ b/docs/faq/general-faq/itunes-compatibility.md @@ -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. diff --git a/docs/general-faq/media-pack-not-found.md b/docs/faq/general-faq/media-pack-not-found.md similarity index 100% rename from docs/general-faq/media-pack-not-found.md rename to docs/faq/general-faq/media-pack-not-found.md diff --git a/docs/general-faq/microsoft-account-usage.md b/docs/faq/general-faq/microsoft-account-usage.md similarity index 100% rename from docs/general-faq/microsoft-account-usage.md rename to docs/faq/general-faq/microsoft-account-usage.md diff --git a/docs/general-faq/microsoft-store.md b/docs/faq/general-faq/microsoft-store.md similarity index 95% rename from docs/general-faq/microsoft-store.md rename to docs/faq/general-faq/microsoft-store.md index 2505132e..f50f58aa 100644 --- a/docs/general-faq/microsoft-store.md +++ b/docs/faq/general-faq/microsoft-store.md @@ -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** diff --git a/docs/general-faq/resetting-atlas.md b/docs/faq/general-faq/resetting-atlas.md similarity index 92% rename from docs/general-faq/resetting-atlas.md rename to docs/faq/general-faq/resetting-atlas.md index 7bdf1ffe..e6f1ffda 100644 --- a/docs/general-faq/resetting-atlas.md +++ b/docs/faq/general-faq/resetting-atlas.md @@ -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) \ No newline at end of file +[:link: Reverting Atlas Guide](../install-faq/reverting-atlas.md) \ No newline at end of file diff --git a/docs/general-faq/roblox-not-launching.md b/docs/faq/general-faq/roblox-not-launching.md similarity index 100% rename from docs/general-faq/roblox-not-launching.md rename to docs/faq/general-faq/roblox-not-launching.md diff --git a/docs/general-faq/testing-nightly-builds.md b/docs/faq/general-faq/testing-nightly-builds.md similarity index 81% rename from docs/general-faq/testing-nightly-builds.md rename to docs/faq/general-faq/testing-nightly-builds.md index f649bfd2..992d5e90 100644 --- a/docs/general-faq/testing-nightly-builds.md +++ b/docs/faq/general-faq/testing-nightly-builds.md @@ -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) diff --git a/docs/general-faq/updating-atlas.md b/docs/faq/general-faq/updating-atlas.md similarity index 93% rename from docs/general-faq/updating-atlas.md rename to docs/faq/general-faq/updating-atlas.md index 73b8d4b3..d9cad846 100644 --- a/docs/general-faq/updating-atlas.md +++ b/docs/faq/general-faq/updating-atlas.md @@ -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. diff --git a/docs/general-faq/upgrading-windows-version.md b/docs/faq/general-faq/upgrading-windows-version.md similarity index 96% rename from docs/general-faq/upgrading-windows-version.md rename to docs/faq/general-faq/upgrading-windows-version.md index 48a50273..5978f864 100644 --- a/docs/general-faq/upgrading-windows-version.md +++ b/docs/faq/general-faq/upgrading-windows-version.md @@ -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. \ No newline at end of file diff --git a/docs/general-faq/verify-iso-integrity.md b/docs/faq/general-faq/verify-iso-integrity.md similarity index 100% rename from docs/general-faq/verify-iso-integrity.md rename to docs/faq/general-faq/verify-iso-integrity.md diff --git a/docs/general-faq/windows-10-vs-11.md b/docs/faq/general-faq/windows-10-vs-11.md similarity index 92% rename from docs/general-faq/windows-10-vs-11.md rename to docs/faq/general-faq/windows-10-vs-11.md index aad106ac..7efd6355 100644 --- a/docs/general-faq/windows-10-vs-11.md +++ b/docs/faq/general-faq/windows-10-vs-11.md @@ -30,5 +30,5 @@ Using Windows 11 as the base for your AtlasOS installation is crucial for: We strongly advise against new installations using Windows 10. -[:link: View Supported Windows Versions](/install-faq/windows-version-support) -[:link: Atlas Installation Guide](/getting-started/installation) \ No newline at end of file +[:link: View Supported Windows Versions](../install-faq/windows-version-support.md) +[:link: Atlas Installation Guide](../../getting-started/index.md) \ No newline at end of file diff --git a/docs/general-faq/windows-update-errors.md b/docs/faq/general-faq/windows-update-errors.md similarity index 100% rename from docs/general-faq/windows-update-errors.md rename to docs/faq/general-faq/windows-update-errors.md diff --git a/docs/faq/index.md b/docs/faq/index.md new file mode 100644 index 00000000..bc4c23a6 --- /dev/null +++ b/docs/faq/index.md @@ -0,0 +1,23 @@ +--- +description: FAQ Page +icon: material/frequently-asked-questions +--- + +# :material-frequently-asked-questions: Frequently Asked Questions (FAQ) + +Welcome to the Atlas FAQ! Here you'll find answers to the most common questions about AtlasOS, installation, troubleshooting, and more. + +## Recommended Topics + +- [General Questions](general-faq/atlas-and-security.md) +- [Resetting Atlas](general-faq/resetting-atlas.md) +- [Upgrading Windows Version](general-faq/upgrading-windows-version.md) +- [Microsoft Store Problems](general-faq/microsoft-store.md) +- [Atlas Folder Missing](general-faq/atlas-folder-missing.md) +- [Game Launch Issues](general-faq/fifa-and-eafc-not-launching.md) +- [Media Pack Not Found](general-faq/media-pack-not-found.md) +- [Windows Update Errors](general-faq/windows-update-errors.md) + +For more detailed answers, browse the categories in the sidebar or use the search bar above. + +If you can't find your answer, please visit our [Discord](https://discord.com/invite/atlasos) or [GitHub Issues](https://github.com/Atlas-OS/docs/issues) for further support. diff --git a/docs/install-faq/ame-wizard-errors/ame-wizard-deleted.md b/docs/faq/install-faq/ame-wizard-errors/ame-wizard-deleted.md similarity index 100% rename from docs/install-faq/ame-wizard-errors/ame-wizard-deleted.md rename to docs/faq/install-faq/ame-wizard-errors/ame-wizard-deleted.md diff --git a/docs/install-faq/ame-wizard-errors/atlas-playbook-stuck.md b/docs/faq/install-faq/ame-wizard-errors/atlas-playbook-stuck.md similarity index 91% rename from docs/install-faq/ame-wizard-errors/atlas-playbook-stuck.md rename to docs/faq/install-faq/ame-wizard-errors/atlas-playbook-stuck.md index 42d6ab7c..4a7ee06f 100644 --- a/docs/install-faq/ame-wizard-errors/atlas-playbook-stuck.md +++ b/docs/faq/install-faq/ame-wizard-errors/atlas-playbook-stuck.md @@ -12,11 +12,11 @@ When running the Playbook, some users might experience these messages: Most of the time, this isn't an issue and is likely due to a slow internet connection or computer. However, it could be stuck if it has been on this screen for a long time. In that case, [scroll down to see solutions](#prerequisites). -![AME Wizard 'Apply Playbook' window demonstrating what 'Reticulating Splines' and 'Action taking a long time' looks like](../../assets/images/reticulating-splines.webp) +![AME Wizard 'Apply Playbook' window demonstrating what 'Reticulating Splines' and 'Action taking a long time' looks like](../../../assets/images/reticulating-splines.webp) ## :material-broom: Prerequisites -1. Ensure that you're on a fresh install of fully updated Windows. We **highly** recommend following our [installation guide](../../getting-started/installation.md) for this. Installing Atlas on a non-fresh Windows installation is considered unsupported and can cause the Playbook to get stuck. +1. Ensure that you're on a fresh install of fully updated Windows. We **highly** recommend following our [installation guide](../../../getting-started/index.md) for this. Installing Atlas on a non-fresh Windows installation is considered unsupported and can cause the Playbook to get stuck. 1. Make sure that your hardware is stable. If you have overclocks, try turning them off. diff --git a/docs/install-faq/ame-wizard-errors/build-not-supported.md b/docs/faq/install-faq/ame-wizard-errors/build-not-supported.md similarity index 85% rename from docs/install-faq/ame-wizard-errors/build-not-supported.md rename to docs/faq/install-faq/ame-wizard-errors/build-not-supported.md index f47a158f..bbcf367a 100644 --- a/docs/install-faq/ame-wizard-errors/build-not-supported.md +++ b/docs/faq/install-faq/ame-wizard-errors/build-not-supported.md @@ -9,6 +9,6 @@ icon: material/microsoft-windows-classic You'll see an error under **"Requirements not met"** saying that your Windows build isn't supported. To get to [a supported version](../windows-version-support.md), follow the installation guide. -[Installing AtlasOS -->](../../getting-started/installation.md) +[Installing AtlasOS -->](../../../getting-started/index.md) -![Screenshot of AME Wizard with the Atlas playbook, with the error 'This Windows build is not supported by this Playbook.'](../../assets/images/atlas-build-unsupported.webp) \ No newline at end of file +![Screenshot of AME Wizard with the Atlas playbook, with the error 'This Windows build is not supported by this Playbook.'](../../../assets/images/atlas-build-unsupported.webp) \ No newline at end of file diff --git a/docs/install-faq/ame-wizard-errors/cant-disable-defender.md b/docs/faq/install-faq/ame-wizard-errors/cant-disable-defender.md similarity index 83% rename from docs/install-faq/ame-wizard-errors/cant-disable-defender.md rename to docs/faq/install-faq/ame-wizard-errors/cant-disable-defender.md index 1b4379af..765ddb39 100644 --- a/docs/install-faq/ame-wizard-errors/cant-disable-defender.md +++ b/docs/faq/install-faq/ame-wizard-errors/cant-disable-defender.md @@ -9,6 +9,6 @@ icon: material/shield-search Atlas requires you to follow the installation documentation to reinstall the latest version of Windows. We advise against using the **Reset this PC** feature within Windows, as this is not considered a complete Windows reinstall and would likely not solve this issue. -[Installing AtlasOS -->](../../getting-started/installation.md) +[Installing AtlasOS -->](../../../getting-started/index.md) -![AME Wizard erroring saying it can't open Windows Defender settings](../../assets/images/ame-defender-inaccessible.png) +![AME Wizard erroring saying it can't open Windows Defender settings](../../../assets/images/ame-defender-inaccessible.png) diff --git a/docs/install-faq/atlas-iso-files.md b/docs/faq/install-faq/atlas-iso-files.md similarity index 79% rename from docs/install-faq/atlas-iso-files.md rename to docs/faq/install-faq/atlas-iso-files.md index 25ef30ca..d16d87b3 100644 --- a/docs/install-faq/atlas-iso-files.md +++ b/docs/faq/install-faq/atlas-iso-files.md @@ -15,8 +15,8 @@ Distributing ISO files violates Microsoft's terms and poses **major safety risks ## How does Atlas work then? -To ensure compliance and safety, you install Atlas by using [AME Wizard](https://ameliorated.io/), which modifies stock Windows installations. We recommend reading our [installation guide](../getting-started/installation.md) to install Atlas using this system. +To ensure compliance and safety, you install Atlas by using [AME Wizard](https://ameliorated.io/), which modifies stock Windows installations. We recommend reading our [installation guide](../../getting-started/index.md) to install Atlas using this system. ## What does the ISO downloader do? -The [ISO downloader in our documentation](../getting-started/installation.md#1-download-an-iso) downloads unmodified ISOs directly from Microsoft's servers. They are there for your convenience. +The [ISO downloader in our documentation](../../getting-started/install/install-playbook.md#1-download-an-iso) downloads unmodified ISOs directly from Microsoft's servers. They are there for your convenience. diff --git a/docs/install-faq/decrypting-using-bitlocker.md b/docs/faq/install-faq/decrypting-using-bitlocker.md similarity index 66% rename from docs/install-faq/decrypting-using-bitlocker.md rename to docs/faq/install-faq/decrypting-using-bitlocker.md index 033e7254..099494ae 100644 --- a/docs/install-faq/decrypting-using-bitlocker.md +++ b/docs/faq/install-faq/decrypting-using-bitlocker.md @@ -14,7 +14,7 @@ Device encryption is enabled by default on many Windows 11 laptops. Although thi 1. Search for **cmd** in the Start menu, right-click on it, and select **Run as administrator**. 1. Type `manage-bde -off %SystemDrive%` and press ++enter++. This command starts the decryption process. - - If you see the error message ["This volume stores external key(s) that can automatically unlock other volumes"](../assets/images/bitlocker-error-decrypting.jpg), type `manage-bde -autounlock -ClearAllKeys %SystemDrive%` and press ++enter++ to clear the keys. After completion, re-type `manage-bde -off %SystemDrive%` and press ++enter++ to continue decrypting. + - If you see the error message ["This volume stores external key(s) that can automatically unlock other volumes"](../../assets/images/bitlocker-error-decrypting.jpg), type `manage-bde -autounlock -ClearAllKeys %SystemDrive%` and press ++enter++ to clear the keys. After completion, re-type `manage-bde -off %SystemDrive%` and press ++enter++ to continue decrypting. 1. If you see the message **Decryption is now in progress**, you have completed the steps correctly. The decryption process will take some time. -1. To check the progress, type `manage-bde -status` and look at the ["Percentage Encrypted"](../assets/images/bitlocker-decryption-progress.webp). Once it has reached **0%**, you've successfully decrypted the drive! -1. [:material-cogs: Go back to the installation guide -->](../getting-started/installation.md#3-reinstalling-windows) +1. To check the progress, type `manage-bde -status` and look at the ["Percentage Encrypted"](../../assets/images/bitlocker-decryption-progress.webp). Once it has reached **0%**, you've successfully decrypted the drive! +1. [:material-cogs: Go back to the installation guide -->](../../getting-started/install/install-playbook.md#3-reinstalling-windows) diff --git a/docs/install-faq/removed-features.md b/docs/faq/install-faq/removed-features.md similarity index 100% rename from docs/install-faq/removed-features.md rename to docs/faq/install-faq/removed-features.md diff --git a/docs/getting-started/reverting-atlas.md b/docs/faq/install-faq/reverting-atlas.md similarity index 69% rename from docs/getting-started/reverting-atlas.md rename to docs/faq/install-faq/reverting-atlas.md index 180badf3..3afafc8f 100644 --- a/docs/getting-started/reverting-atlas.md +++ b/docs/faq/install-faq/reverting-atlas.md @@ -31,26 +31,23 @@ Alternatively, give feedback in our GitHub Discussions or Discord, as mentioned --- !!! tip "Looking to reinstall/install Atlas?" - Follow the [Atlas installation guide](installation.md) instead. This page is for reverting Atlas. + Follow the [Atlas installation guide](../../getting-started/install/before-continuing.md) instead. This page is for reverting Atlas. --8<-- -installation.md:style -installation.md:iso -installation.md:iso1 +../../getting-started/install/install-playbook.md:style +../../getting-started/install/install-playbook.md:iso +../../getting-started/install/install-playbook.md:iso1 --8<-- {% include 'msdl.md' %} --8<-- -installation.md:drivers -installation.md:reinstalling -installation.md:reinstalling1 -installation.md:reinstalling2 - installation.md:windowsOldNotice -installation.md:reinstalling3 +../../getting-started/install/install-playbook.md:drivers +../../getting-started/install/install-playbook.md:reinstalling +../../getting-started/install/install-playbook.md:reinstalling1 +../../getting-started/install/install-playbook.md:reinstalling2 + ../../getting-started/install/install-playbook.md:windowsOldNotice +../../getting-started/install/install-playbook.md:reinstalling3 --8<-- ## **4.** :material-desktop-classic: Continue with setup -You should now be at the regular Windows initial setup and back on stock Windows. - -### **4.1.** :material-microsoft-windows-classic: Your old Windows installation ---8<-- "installation.md:oldinstall" \ No newline at end of file +You should now be at the regular Windows initial setup and back on stock Windows. \ No newline at end of file diff --git a/docs/install-faq/who-is-atlas-for.md b/docs/faq/install-faq/who-is-atlas-for.md similarity index 100% rename from docs/install-faq/who-is-atlas-for.md rename to docs/faq/install-faq/who-is-atlas-for.md diff --git a/docs/install-faq/windows-home.md b/docs/faq/install-faq/windows-home.md similarity index 90% rename from docs/install-faq/windows-home.md rename to docs/faq/install-faq/windows-home.md index bf171432..518fd8bc 100644 --- a/docs/install-faq/windows-home.md +++ b/docs/faq/install-faq/windows-home.md @@ -7,7 +7,7 @@ icon: material/home-remove **Although you can install Atlas on Windows Home, we do not recommend it as some of Atlas' privacy, usability, and performance optimizations don't apply.** -Atlas uses group policies to tweak various parts of Windows that generally can't be done in regular Settings. However, many group policies on Windows Home do not work, such as disabling [**Automatic Driver Installation**](../getting-started/installation.md#driver-updates). +Atlas uses group policies to tweak various parts of Windows that generally can't be done in regular Settings. However, many group policies on Windows Home do not work, such as disabling [**Automatic Driver Installation**](../../getting-started/install/install-playbook.md#5-driver-updates). Additionally, Windows Home is missing valuable features, such as:[^1] diff --git a/docs/install-faq/windows-version-support.md b/docs/faq/install-faq/windows-version-support.md similarity index 88% rename from docs/install-faq/windows-version-support.md rename to docs/faq/install-faq/windows-version-support.md index aa1ed5e2..022eee2d 100644 --- a/docs/install-faq/windows-version-support.md +++ b/docs/faq/install-faq/windows-version-support.md @@ -37,4 +37,4 @@ We recommend **Windows Pro** or **Windows Enterprise**. With the exception of [W - **Enterprise LTSC:** These editions often lag behind the latest Windows versions, which we don't test or support. - **Windows Server:** Supporting these would require too much extra testing. -We *strongly recommend* following our [installation guide](../getting-started/installation.md) for installing a supported version, as the initial Atlas install requires a Windows reinstallation regardless. +We *strongly recommend* following our [installation guide](../../getting-started/index.md) for installing a supported version, as the initial Atlas install requires a Windows reinstallation regardless. diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md new file mode 100644 index 00000000..e70b0bd4 --- /dev/null +++ b/docs/getting-started/index.md @@ -0,0 +1,40 @@ +--- +description: Choose your way to start your AtlasOS journey, fresh or upgrade your current installation +icon: material/book-information-variant +--- +# :material-book-information-variant: Getting Started +Choose your way to start your AtlasOS journey! + +
+ +- #### :material-cogs: Fresh Install + + --- + + For systems that do not have Atlas installed, or matching anything below. + + **Situations:** + + - Atlas version ≀ v0.4.0 + - Using AtlasOS on Windows 10 + + --- + + **[-> Install](install/before-continuing.md)** + +- #### :material-rocket: Update Current Install + + --- + + For systems that currently have Atlas installed. + + **Requirements:** + + - Currently on Atlas v0.4.1 + - Using AtlasOS on Windows 11 24H2 + + --- + + **[-> Upgrade](upgrade/before-continuing.md)** + +
diff --git a/docs/getting-started/install/before-continuing.md b/docs/getting-started/install/before-continuing.md new file mode 100644 index 00000000..4e0cc375 --- /dev/null +++ b/docs/getting-started/install/before-continuing.md @@ -0,0 +1,44 @@ +--- +description: Verify system requirements and backup your data before installing AtlasOS +icon: material/information +--- + +Please confirm that you have met all of the following requirements. + +- **Backed up all of your current install's data to somewhere safe.** + - Cloud Storage (Google Drive, Microsoft Onedrive, Dropbox) + - Private Storage (NAS, Portable Storage, USB Drive) + +- Meeting the **system requirements for [Windows 11](https://www.microsoft.com/windows/windows-11-specifications#table1)** + +- **64-bit CPU** ([you can check what you have](https://support.microsoft.com/en-us/windows/which-version-of-windows-operating-system-am-i-running-628bec99-476a-2c13-5296-9dd081cdd808)) + +## :material-monitor-arrow-down: Choose your Install Method + +Atlas provides two installation methods, Playbook & ISO Injection. + +
+ +- #### :material-book-cog: Playbook + + --- + + Traditional Playbook method, best for average users. + + --- + + **[-> Install with Playbook](install-playbook.md)** + +- #### :material-minidisc: ISO Injection + + --- + + New installation method for experienced users. + + + --- + + **[-> Install with ISO Injection](install-iso-injection.md)** + +
+ diff --git a/docs/getting-started/install/install-iso-injection.md b/docs/getting-started/install/install-iso-injection.md new file mode 100644 index 00000000..c90529e5 --- /dev/null +++ b/docs/getting-started/install/install-iso-injection.md @@ -0,0 +1,14 @@ +--- +description: Install AtlasOS using the ISO injection method for experienced users +icon: material/disc-player +--- + +## TBD + + + +
+ +- #### Next: **[-> Setting up Atlas](setting-up.md)** + +
\ No newline at end of file diff --git a/docs/getting-started/installation.md b/docs/getting-started/install/install-playbook.md similarity index 67% rename from docs/getting-started/installation.md rename to docs/getting-started/install/install-playbook.md index cf816c34..4347237b 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/install/install-playbook.md @@ -1,14 +1,14 @@ --- title: Installation -description: The official AtlasOS playbook installation guide -icon: material/cogs +description: The official AtlasOS Playbook installation guide +icon: material/book-arrow-down --- # :material-package-down: Installing AtlasOS This guide will walk you through fully reinstalling Windows, installing Atlas on top of it, and completing other necessary steps. A full Windows reinstall is needed to ensure stability during the initial installation of Atlas. -Before continuing, we recommend reviewing our page to see [who Atlas is for](../install-faq/who-is-atlas-for.md). +Before continuing, we recommend reviewing our page to see [who Atlas is for](../../faq/install-faq/who-is-atlas-for.md).