Skip to content

Update/Add Documentation Based on Common User Questions #261

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.

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

Merged
merged 12 commits into from
Mar 31, 2025

Conversation

jacksyrm
Copy link
Member

Type

  • Rewrite already written documentation
  • Add/remove new pages

Questions

Describe your pull request

This PR introduces several improvements and updates to the documentation, driven by analysing the most common questions asked by users via our AI chatbot on the documentation website and Discord server.

  • New FAQ Pages:
    • Added general-faq/enabling-tpm.md to address Windows 11 installation requirement errors.
    • Added several other FAQ pages covering topics such as checking the AtlasOS version, upgrading Windows, comparing Windows 10 vs 11, installation data loss, Microsoft account usage, and resetting Atlas.
  • general-faq/updating-atlas.md Improvements:
    • Rewrote the page for improved clarity on the update process based on the current AtlasOS version.
    • Added a link to the new version checking guide.
    • Improved structure and guidance for users on older, unsupported versions.
  • getting-started/installation.md Update:
    • Added a note linking to the new TPM 2.0 guide for users installing Windows 11.
    • Fixed a minor syntax error in a MkDocs include tag.
  • Navigation (mkdocs.yml) Restructuring:
    • Restructured the "General FAQ" section for better organisation, separating common questions from troubleshooting and advanced topics.
    • Added all new FAQ pages to the navigation structure.
  • Minor Title Update:
    • Updated the title in general-faq/atlas-and-security.md for consistency.

@jacksyrm jacksyrm added the enhancement New feature or request label Mar 30, 2025
@jacksyrm jacksyrm self-assigned this Mar 30, 2025
@jacksyrm jacksyrm requested a review from whallin as a code owner March 30, 2025 19:40
@jacksyrm jacksyrm requested a review from RadNotRed as a code owner March 30, 2025 19:40
@github-actions github-actions bot added getting-started Issues or PRs related to the 'Getting Started' page mkdocs-config Issues or PRs related to the MkDocs configuration labels Mar 30, 2025
@RadNotRed RadNotRed requested a review from Copilot March 30, 2025 20:10
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates and expands the documentation by adding new FAQ pages and improving existing guides based on common user questions. Key changes include:

  • Introduction of new FAQ pages (e.g., Enabling TPM 2.0, Microsoft Account Usage) and restructuring of the navigation.
  • Improvements to the "Updating AtlasOS" and "Installation" guides for clarity and accuracy.
  • Minor adjustments to page titles and syntax corrections in documentation files.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mkdocs.yml Updated navigation structure to include new FAQ pages
docs/getting-started/installation.md Added TPM guidance notes and corrected an include tag syntax
docs/general-faq/windows-10-vs-11.md New page comparing Windows versions with emphasis on Windows 11
docs/general-faq/upgrading-windows-version.md New guide describing why Windows upgrade is unsupported
docs/general-faq/updating-atlas.md Rewritten page clarifying update process and support options
docs/general-faq/resetting-atlas.md New page detailing proper reset/reinstallation procedure
docs/general-faq/microsoft-account-usage.md New guide on Microsoft account usage in AtlasOS
docs/general-faq/installation-data-loss.md New page explaining installation requirements and data considerations
docs/general-faq/enabling-tpm.md New guide on enabling TPM 2.0 in BIOS/UEFI for Windows 11
docs/general-faq/checking-atlas-version.md New guide for checking the installed AtlasOS version
docs/general-faq/atlas-and-security.md Minor title update for consistency with AtlasOS branding

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

cloudflare-workers-and-pages bot commented Mar 30, 2025

Deploying atlasos-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c986d0e
Status: ✅  Deploy successful!
Preview URL: https://f524eca3.atlasos-docs-enq.pages.dev
Branch Preview URL: https://jacksyrm-pages-overhaul.atlasos-docs-enq.pages.dev

View logs

@the-P1neapple
Copy link
Member

Good Job @jacksyrm, looks great

Copy link
Member

@pencilnav pencilnav left a comment

Choose a reason for hiding this comment

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

impressive! 👍

@Xyueta Xyueta merged commit ac87ec8 into main Mar 31, 2025
2 checks passed
@Xyueta Xyueta deleted the jacksyrm/pages-overhaul branch March 31, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request getting-started Issues or PRs related to the 'Getting Started' page mkdocs-config Issues or PRs related to the MkDocs configuration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants