From 6f0629207ac1411c32a692aa6ec20398483ebe57 Mon Sep 17 00:00:00 2001 From: "Sean (ANGRYxScotsman)" <36518683+seanh1995@users.noreply.github.com> Date: Fri, 31 Jul 2026 21:29:00 +0100 Subject: [PATCH] Gave the docs steroids. sorry for the big pr. (#4892) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Scaffold Astro + Starlight docs site Bootstraps a new docs-astro project to replace the Hugo-based docs, using Astro's Starlight framework with the content collection schema and sidebar navigation configured for WinUtil's docs structure. * Add WinUtil-branded Starlight theme Restyles Starlight's default look with a dark-by-default grayscale palette and WinUtil's brand blue (#0567ff, from the app logo) as the single accent, Geist for UI text, and JetBrains Mono for code. Also overrides the default theme provider so first-time visitors land on dark mode instead of following OS preference. * Add custom Hero and CornerCard components Hero overrides Starlight's default hero with a full-bleed grid/glow background, a browser-chrome-framed screenshot, and a badge row driven by frontmatter data. CornerCard is a bordered feature card with corner brackets, used for the landing page's feature grid. * Migrate docs content from Hugo to Astro/Starlight Ports the landing page, user guide sections, FAQ, known issues, contributing guide, and a sample generated tweak reference page from the Hugo site, converting Hugo shortcodes and GFM alert syntax to their Starlight/MDX equivalents. * Use Windows-style caption buttons in hero window chrome Swap the macOS traffic-light dots for a minimize/maximize/close button group, since WinUtil is a Windows tool. * Use Windows-style caption glyph for terminal code blocks Replace Expressive Code's default macOS dots on terminal-framed code blocks with a right-aligned Windows minimize/maximize/close icon, matching the hero window chrome. * Archive the Hugo docs site as docs-old * Promote Astro/Starlight docs from docs-astro to docs * Show the launch command as a copyable code block on the docs homepage * Add docs codeowner for seanh1995 * Register custom Header component for Starlight docs site * Add custom navbar links to Astro docs, matching the old Hugo site's top nav * Point dev docs generator at the Astro/Starlight docs site Output moves from docs/content/dev (Hugo) to docs/src/content/docs/code-reference (Astro/Starlight): .mdx instead of .md, Starlight-style title="..." code fence labels instead of Hugo's filename/linenos shortcode, and a ":::note" aside linking back to each entry's source file. Frontmatter description is now pulled from the JSON Description field. Also fixes a pre-existing bug where the embedded JSON snippets were always missing their own closing brace. * Add seanh1995 as codeowner for the dev docs generator * Wire up Code Reference section in docs sidebar Adds an Architecture & Design page plus autogenerated Tweaks/Features Reference groups pointing at docs/src/content/docs/code-reference, and fixes the editLink base URL to the promoted docs/ path. * Port architecture doc to code-reference and drop stale hyperv sample Moves the Hugo-era architecture doc into docs/src/content/docs/code-reference/architecture.mdx: drops the Hugo-only weight/toc frontmatter, converts the embedded code fences to Starlight's title="..." syntax, and repoints the "Related Documentation" links at this site's actual slugs. Also removes the hand-written reference/tweaks/hyperv.mdx placeholder now that the generator produces the real page under code-reference/features. * Keep pre-conversion backup of devdocs-generator.ps1 Snapshot of the script before it was pointed at the Astro/Starlight docs site, for reference. * updated workflow * Update CODEOWNERS * Hide edit-page link on the docs landing page The splash-template landing page isn't a source doc meant to be edited via GitHub like the rest of the guides, so skip showing the link. * Add site footer with copyright line, matching the old Hugo docs The Hugo site rendered "Β© {year} Chris Titus Tech. All rights reserved." in its footer; Starlight's default footer had no equivalent. Override it to append the same copyright line below the existing edit-link/pagination row, and collapse that row entirely when it has nothing in it (e.g. pages with editUrl disabled and no prev/next) instead of leaving an empty gap. * Fix vertical alignment and size of the arrow icon in hero/CTA buttons The right-arrow icon read as floating above the button label's baseline. Root cause was partly a genuine optical mismatch (fixed with a small position nudge scoped to just the arrow icon, so it doesn't also shift the unaffected GitHub icon) and partly the final CTA's copy getting wrapped in a
by MDX's markdown parser, which behaved
slightly differently under the flex layout than the Hero component's
plain text node. Switching the CTA button's label to a JS string
expression avoids the wrapper and keeps both buttons' markup, and
rendering, identical.
* Use the dark fork-button screenshot in the contributing guide
Drop the unused light-mode variant and point the guide at
Fork-Button-Dark.png instead.
* Remove old Hugo docs site and pre-conversion backup files
The docs have moved to the Astro/Starlight site; the Hugo site
(docs-old/), its workflow backup, and the devdocs-generator.ps1
pre-conversion snapshot are no longer needed.
* keeping ai happy
* Bump sharp to 0.35.3 in docs site
---
.github/CODEOWNERS | 6 +-
.github/workflows/docs.yaml | 45 +-
.gitignore | 8 +-
docs/.gitignore | 21 +
docs/README.md | 49 +
docs/archetypes/default.md | 6 -
docs/assets/images/Fork-Button-Light.png | Bin 22924 -> 0 bytes
docs/assets/images/updates-tab-new.png | Bin 56020 -> 0 bytes
docs/astro.config.mjs | 64 +
docs/content/_index.md | 28 -
docs/content/dev/_index.md | 52 -
.../Features/DisableLegacyRecovery.md | 16 -
.../features/Features/EnableLegacyRecovery.md | 16 -
.../dev/features/Features/RegBackup.md | 22 -
docs/content/dev/features/Features/Sandbox.md | 15 -
docs/content/dev/features/Features/_index.md | 7 -
docs/content/dev/features/Features/dotnet.md | 17 -
docs/content/dev/features/Features/hyperv.md | 15 -
.../dev/features/Features/legacymedia.md | 19 -
docs/content/dev/features/Features/nfs.md | 24 -
docs/content/dev/features/Features/wsl.md | 17 -
docs/content/dev/features/Fixes/Autologin.md | 11 -
docs/content/dev/features/Fixes/DISM.md | 26 -
docs/content/dev/features/Fixes/NTPPool.md | 27 -
docs/content/dev/features/Fixes/Network.md | 12 -
docs/content/dev/features/Fixes/Update.md | 233 -
docs/content/dev/features/Fixes/Winget.md | 30 -
docs/content/dev/features/Fixes/_index.md | 7 -
.../Legacy-Windows-Panels/Computer.md | 16 -
.../features/Legacy-Windows-Panels/Control.md | 16 -
.../Legacy-Windows-Panels/Firewall.md | 16 -
.../features/Legacy-Windows-Panels/Mouse.md | 16 -
.../features/Legacy-Windows-Panels/Network.md | 16 -
.../features/Legacy-Windows-Panels/Power.md | 16 -
.../features/Legacy-Windows-Panels/Printer.md | 16 -
.../Legacy-Windows-Panels/Programs.md | 16 -
.../features/Legacy-Windows-Panels/Region.md | 16 -
.../features/Legacy-Windows-Panels/Restore.md | 16 -
.../Legacy-Windows-Panels/Security.md | 16 -
.../features/Legacy-Windows-Panels/Sound.md | 16 -
.../features/Legacy-Windows-Panels/System.md | 16 -
.../Legacy-Windows-Panels/Timedate.md | 16 -
.../features/Legacy-Windows-Panels/_index.md | 7 -
.../InstallPSProfile.md | 22 -
.../UninstallPSProfile.md | 17 -
.../_index.md | 7 -
.../dev/features/Remote-Access/SSHServer.md | 24 -
.../dev/features/Remote-Access/_index.md | 7 -
docs/content/dev/features/_index.md | 25 -
.../BatteryPercentage.md | 29 -
.../Customize-Preferences/BingSearch.md | 29 -
.../tweaks/Customize-Preferences/DarkMode.md | 53 -
.../Customize-Preferences/DetailedBSoD.md | 37 -
.../DisableLockscreen.md | 28 -
.../tweaks/Customize-Preferences/GameMode.md | 37 -
.../Customize-Preferences/HiddenFiles.md | 39 -
.../Customize-Preferences/HideSettingsHome.md | 29 -
.../tweaks/Customize-Preferences/LoginBlur.md | 29 -
.../tweaks/Customize-Preferences/LongPaths.md | 29 -
.../MouseAcceleration.md | 45 -
.../MultiplaneOverlay.md | 37 -
.../Customize-Preferences/NewOutlook.md | 53 -
.../tweaks/Customize-Preferences/NumLock.md | 37 -
.../tweaks/Customize-Preferences/S3Sleep.md | 29 -
.../Customize-Preferences/Scrollbars.md | 30 -
.../tweaks/Customize-Preferences/ShowExt.md | 39 -
.../Customize-Preferences/StandbyFix.md | 29 -
.../StartMenuRecommendations.md | 55 -
.../Customize-Preferences/StickyKeys.md | 29 -
.../tweaks/Customize-Preferences/TaskView.md | 29 -
.../Customize-Preferences/TaskbarAlignment.md | 39 -
.../Customize-Preferences/TaskbarSearch.md | 29 -
.../Customize-Preferences/VerboseLogon.md | 29 -
.../Customize-Preferences/WindowSnapping.md | 29 -
.../tweaks/Customize-Preferences/_index.md | 9 -
.../dev/tweaks/Essential-Tweaks/Activity.md | 41 -
.../Essential-Tweaks/ConsumerFeatures.md | 27 -
.../Essential-Tweaks/DeleteTempFiles.md | 18 -
.../Essential-Tweaks/DeliveryOptimization.md | 27 -
.../Essential-Tweaks/DisableBitLocker.md | 18 -
.../DisableExplorerAutoDiscovery.md | 60 -
.../Essential-Tweaks/DisableStoreSearch.md | 18 -
.../tweaks/Essential-Tweaks/DiskCleanup.md | 18 -
.../Essential-Tweaks/EndTaskOnTaskbar.md | 27 -
.../dev/tweaks/Essential-Tweaks/Hiber.md | 40 -
.../dev/tweaks/Essential-Tweaks/Location.md | 48 -
.../PreventDeviceMetadataFromNetwork.md | 27 -
.../tweaks/Essential-Tweaks/RestorePoint.md | 38 -
.../Essential-Tweaks/RevertStartMenu.md | 27 -
.../dev/tweaks/Essential-Tweaks/Services.md | 45 -
.../dev/tweaks/Essential-Tweaks/Telemetry.md | 136 -
.../dev/tweaks/Essential-Tweaks/WPBT.md | 27 -
.../dev/tweaks/Essential-Tweaks/Widget.md | 24 -
.../dev/tweaks/Essential-Tweaks/_index.md | 9 -
.../dev/tweaks/Performance-Plans/_index.md | 9 -
docs/content/dev/tweaks/_index.md | 21 -
.../BlockAdobeNet.md | 31 -
.../BraveDebloat.md | 104 -
.../DisableBGapps.md | 27 -
.../DisableFSO.md | 27 -
.../DisableIPv6.md | 33 -
.../DisableNotifications.md | 34 -
.../DisableWarningForUnsignedRdp.md | 34 -
.../z--Advanced-Tweaks---CAUTION/Display.md | 110 -
.../EdgeDebloat.md | 139 -
.../z--Advanced-Tweaks---CAUTION/IPv46.md | 27 -
.../OOSUbutton.md | 57 -
.../RazerBlock.md | 52 -
.../RemoveEdge.md | 31 -
.../RemoveHomeAndGallery.md | 41 -
.../RemoveOneDrive.md | 49 -
.../ReservedStorage.md | 18 -
.../RightClickMenu.md | 21 -
.../z--Advanced-Tweaks---CAUTION/Storage.md | 27 -
.../z--Advanced-Tweaks---CAUTION/Teredo.md | 33 -
.../z--Advanced-Tweaks---CAUTION/UTC.md | 27 -
.../z--Advanced-Tweaks---CAUTION/WindowsAI.md | 55 -
.../z--Advanced-Tweaks---CAUTION/_index.md | 9 -
.../z--Advanced-Tweaks---CAUTION/changedns.md | 13 -
docs/content/userguide/application/_index.md | 57 -
.../userguide/getting-started/_index.md | 256 -
docs/go.mod | 5 -
docs/go.sum | 2 -
docs/hugo.toml | 140 -
docs/i18n/en.yaml | 23 -
docs/layouts/shortcodes/autolinks.html | 17 -
docs/layouts/shortcodes/image.html | 114 -
docs/package-lock.json | 6950 +++++++++++++++++
docs/package.json | 19 +
docs/{static => public}/favicon.svg | 0
.../assets/branding}/navlogo.png | Bin
.../assets/branding/title-screen.png} | Bin
.../assets/contributing}/Commit-GHD.png | Bin
.../assets/contributing}/Complie.png | Bin
.../assets/contributing}/Discard-GHD.png | Bin
.../assets/contributing}/Fork-Button-Dark.png | Bin
.../assets/contributing}/Push-Commit.png | Bin
docs/src/assets/houston.webp | Bin 0 -> 98506 bytes
.../assets/screenshots}/config-tab-new.png | Bin
.../install-pics/clear-selection-apps.png | Bin
.../install-pics/install-apps.png | Bin
.../install-pics/installation.png | Bin
.../install-pics/show-installed-apps.png | Bin
.../install-pics/uninstall-apps.png | Bin
.../assets/screenshots}/tweaks-tab-new.png | Bin
.../screenshots}/win11creator-tab-new.png | Bin
docs/src/components/CornerCard.astro | 123 +
docs/src/components/Footer.astro | 87 +
docs/src/components/Header.astro | 178 +
docs/src/components/Hero.astro | 294 +
docs/src/components/ThemeProvider.astro | 36 +
docs/src/content.config.ts | 29 +
.../docs/code-reference/architecture.mdx} | 19 +-
.../content/docs/contributing.mdx} | 50 +-
.../faq.md => src/content/docs/faq.mdx} | 159 +-
docs/src/content/docs/guides/application.mdx | 57 +
.../content/docs/guides/automation.mdx} | 11 +-
.../content/docs/guides/features.mdx} | 8 +-
.../content/docs/guides/getting-started.mdx | 259 +
.../content/docs/guides/index.mdx} | 57 +-
.../content/docs/guides/tweaks.mdx} | 21 +-
.../content/docs/guides/updates.mdx} | 6 +-
.../content/docs/guides/win11creator.mdx} | 77 +-
docs/src/content/docs/index.mdx | 199 +
.../content/docs/known-issues.mdx} | 2 +-
docs/src/styles/fonts.css | 6 +
docs/src/styles/theme.css | 476 ++
docs/static/CNAME | 1 -
docs/static/android-chrome-192x192.png | Bin 28177 -> 0 bytes
docs/static/android-chrome-512x512.png | Bin 116413 -> 0 bytes
docs/static/apple-touch-icon.png | Bin 25162 -> 0 bytes
docs/static/favicon-16x16.png | Bin 877 -> 0 bytes
docs/static/favicon-32x32.png | Bin 2315 -> 0 bytes
docs/static/favicon.ico | Bin 21897 -> 0 bytes
docs/static/site.webmanifest | 1 -
docs/tsconfig.json | 5 +
tools/devdocs-generator.md | 33 +-
tools/devdocs-generator.ps1 | 68 +-
178 files changed, 9165 insertions(+), 4396 deletions(-)
create mode 100644 docs/.gitignore
create mode 100644 docs/README.md
delete mode 100644 docs/archetypes/default.md
delete mode 100644 docs/assets/images/Fork-Button-Light.png
delete mode 100644 docs/assets/images/updates-tab-new.png
create mode 100644 docs/astro.config.mjs
delete mode 100644 docs/content/_index.md
delete mode 100644 docs/content/dev/_index.md
delete mode 100644 docs/content/dev/features/Features/DisableLegacyRecovery.md
delete mode 100644 docs/content/dev/features/Features/EnableLegacyRecovery.md
delete mode 100644 docs/content/dev/features/Features/RegBackup.md
delete mode 100644 docs/content/dev/features/Features/Sandbox.md
delete mode 100644 docs/content/dev/features/Features/_index.md
delete mode 100644 docs/content/dev/features/Features/dotnet.md
delete mode 100644 docs/content/dev/features/Features/hyperv.md
delete mode 100644 docs/content/dev/features/Features/legacymedia.md
delete mode 100644 docs/content/dev/features/Features/nfs.md
delete mode 100644 docs/content/dev/features/Features/wsl.md
delete mode 100644 docs/content/dev/features/Fixes/Autologin.md
delete mode 100644 docs/content/dev/features/Fixes/DISM.md
delete mode 100644 docs/content/dev/features/Fixes/NTPPool.md
delete mode 100644 docs/content/dev/features/Fixes/Network.md
delete mode 100644 docs/content/dev/features/Fixes/Update.md
delete mode 100644 docs/content/dev/features/Fixes/Winget.md
delete mode 100644 docs/content/dev/features/Fixes/_index.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Computer.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Control.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Firewall.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Mouse.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Network.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Power.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Printer.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Programs.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Region.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Restore.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Security.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Sound.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/System.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/Timedate.md
delete mode 100644 docs/content/dev/features/Legacy-Windows-Panels/_index.md
delete mode 100644 docs/content/dev/features/Powershell-Profile-Powershell-7--Only/InstallPSProfile.md
delete mode 100644 docs/content/dev/features/Powershell-Profile-Powershell-7--Only/UninstallPSProfile.md
delete mode 100644 docs/content/dev/features/Powershell-Profile-Powershell-7--Only/_index.md
delete mode 100644 docs/content/dev/features/Remote-Access/SSHServer.md
delete mode 100644 docs/content/dev/features/Remote-Access/_index.md
delete mode 100644 docs/content/dev/features/_index.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/BatteryPercentage.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/BingSearch.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/DarkMode.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/DetailedBSoD.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/DisableLockscreen.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/GameMode.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/HiddenFiles.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/HideSettingsHome.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/LoginBlur.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/LongPaths.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/MouseAcceleration.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/MultiplaneOverlay.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/NewOutlook.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/NumLock.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/S3Sleep.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/Scrollbars.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/ShowExt.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/StandbyFix.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/StartMenuRecommendations.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/StickyKeys.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/TaskView.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/TaskbarAlignment.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/TaskbarSearch.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/VerboseLogon.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/WindowSnapping.md
delete mode 100644 docs/content/dev/tweaks/Customize-Preferences/_index.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Activity.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/ConsumerFeatures.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DeleteTempFiles.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DeliveryOptimization.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DisableBitLocker.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DisableExplorerAutoDiscovery.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DisableStoreSearch.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/DiskCleanup.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/EndTaskOnTaskbar.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Hiber.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Location.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/PreventDeviceMetadataFromNetwork.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/RestorePoint.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/RevertStartMenu.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Services.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Telemetry.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/WPBT.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/Widget.md
delete mode 100644 docs/content/dev/tweaks/Essential-Tweaks/_index.md
delete mode 100644 docs/content/dev/tweaks/Performance-Plans/_index.md
delete mode 100644 docs/content/dev/tweaks/_index.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/BlockAdobeNet.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/BraveDebloat.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableBGapps.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableFSO.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableIPv6.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableNotifications.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/DisableWarningForUnsignedRdp.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/Display.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/EdgeDebloat.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/IPv46.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/OOSUbutton.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/RazerBlock.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/RemoveEdge.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/RemoveHomeAndGallery.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/RemoveOneDrive.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/ReservedStorage.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/RightClickMenu.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/Storage.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/Teredo.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/UTC.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/WindowsAI.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/_index.md
delete mode 100644 docs/content/dev/tweaks/z--Advanced-Tweaks---CAUTION/changedns.md
delete mode 100644 docs/content/userguide/application/_index.md
delete mode 100644 docs/content/userguide/getting-started/_index.md
delete mode 100644 docs/go.mod
delete mode 100644 docs/go.sum
delete mode 100644 docs/hugo.toml
delete mode 100644 docs/i18n/en.yaml
delete mode 100644 docs/layouts/shortcodes/autolinks.html
delete mode 100644 docs/layouts/shortcodes/image.html
create mode 100644 docs/package-lock.json
create mode 100644 docs/package.json
rename docs/{static => public}/favicon.svg (100%)
rename docs/{static => src/assets/branding}/navlogo.png (100%)
rename docs/{assets/images/Title-Screen.png => src/assets/branding/title-screen.png} (100%)
rename docs/{assets/images => src/assets/contributing}/Commit-GHD.png (100%)
rename docs/{assets/images => src/assets/contributing}/Complie.png (100%)
rename docs/{assets/images => src/assets/contributing}/Discard-GHD.png (100%)
rename docs/{assets/images => src/assets/contributing}/Fork-Button-Dark.png (100%)
rename docs/{assets/images => src/assets/contributing}/Push-Commit.png (100%)
create mode 100644 docs/src/assets/houston.webp
rename docs/{assets/images => src/assets/screenshots}/config-tab-new.png (100%)
rename docs/{assets/images => src/assets/screenshots}/install-pics/clear-selection-apps.png (100%)
rename docs/{assets/images => src/assets/screenshots}/install-pics/install-apps.png (100%)
rename docs/{assets/images => src/assets/screenshots}/install-pics/installation.png (100%)
rename docs/{assets/images => src/assets/screenshots}/install-pics/show-installed-apps.png (100%)
rename docs/{assets/images => src/assets/screenshots}/install-pics/uninstall-apps.png (100%)
rename docs/{assets/images => src/assets/screenshots}/tweaks-tab-new.png (100%)
rename docs/{assets/images => src/assets/screenshots}/win11creator-tab-new.png (100%)
create mode 100644 docs/src/components/CornerCard.astro
create mode 100644 docs/src/components/Footer.astro
create mode 100644 docs/src/components/Header.astro
create mode 100644 docs/src/components/Hero.astro
create mode 100644 docs/src/components/ThemeProvider.astro
create mode 100644 docs/src/content.config.ts
rename docs/{content/dev/architecture.md => src/content/docs/code-reference/architecture.mdx} (97%)
rename docs/{content/CONTRIBUTING.md => src/content/docs/contributing.mdx} (76%)
rename docs/{content/faq.md => src/content/docs/faq.mdx} (77%)
create mode 100644 docs/src/content/docs/guides/application.mdx
rename docs/{content/userguide/automation/_index.md => src/content/docs/guides/automation.mdx} (80%)
rename docs/{content/userguide/features/_index.md => src/content/docs/guides/features.mdx} (87%)
create mode 100644 docs/src/content/docs/guides/getting-started.mdx
rename docs/{content/userguide/_index.md => src/content/docs/guides/index.mdx} (68%)
rename docs/{content/userguide/tweaks/_index.md => src/content/docs/guides/tweaks.mdx} (89%)
rename docs/{content/userguide/updates/_index.md => src/content/docs/guides/updates.mdx} (94%)
rename docs/{content/userguide/win11Creator/_index.md => src/content/docs/guides/win11creator.mdx} (70%)
create mode 100644 docs/src/content/docs/index.mdx
rename docs/{content/KnownIssues.md => src/content/docs/known-issues.mdx} (96%)
create mode 100644 docs/src/styles/fonts.css
create mode 100644 docs/src/styles/theme.css
delete mode 100644 docs/static/CNAME
delete mode 100644 docs/static/android-chrome-192x192.png
delete mode 100644 docs/static/android-chrome-512x512.png
delete mode 100644 docs/static/apple-touch-icon.png
delete mode 100644 docs/static/favicon-16x16.png
delete mode 100644 docs/static/favicon-32x32.png
delete mode 100644 docs/static/favicon.ico
delete mode 100644 docs/static/site.webmanifest
create mode 100644 docs/tsconfig.json
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 52fce025..ebe925d6 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,2 +1,6 @@
# Chris rules EVERYTHING (including paths listed below)
-* @ChrisTitusTech
\ No newline at end of file
+* @ChrisTitusTech
+
+# Seanh1917 (ANGRYxScotsmans) is the docs guy
+docs/ @ChrisTitusTech @seanh1995
+tools/devdocs-generator.* @ChrisTitusTech @seanh1995
\ No newline at end of file
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 77a7e9cc..798b223d 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -1,4 +1,4 @@
-name: Deploy Hugo site to Pages
+name: Deploy Astro site to Pages
on:
push:
@@ -30,23 +30,13 @@ jobs:
if: github.repository == 'ChrisTitusTech/winutil'
runs-on: ubuntu-latest
env:
- HUGO_VERSION: 0.156.0
- HUGO_ENVIRONMENT: production
TZ: America/Chicago
steps:
- - name: Install Hugo CLI
- run: |
- wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
- && sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Checkout
uses: actions/checkout@v7
with:
- submodules: recursive
fetch-depth: 0
persist-credentials: false
- - name: Setup Pages
- id: pages
- uses: actions/configure-pages@v6
- name: Generate Dev Docs from JSON
shell: pwsh
@@ -65,7 +55,7 @@ jobs:
branch: docs-update
delete-branch: true
add-paths: |
- docs/content/dev/
+ docs/src/content/docs/code-reference/
config/tweaks.json
config/feature.json
labels: |
@@ -78,35 +68,10 @@ jobs:
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
- - name: Install Node.js dependencies
- run: "cd docs && [[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
- - name: Cache Restore
- id: cache-restore
- uses: actions/cache/restore@v6
+ - name: Install, build, and upload your site
+ uses: withastro/action@v6
with:
- path: |
- ${{ runner.temp }}/hugo_cache
- key: hugo-${{ github.run_id }}
- restore-keys: hugo-
- - name: Build with Hugo
- run: |
- hugo \
- --gc \
- --minify \
- --cleanDestinationDir \
- --source docs \
- --cacheDir "${{ runner.temp }}/hugo_cache"
- - name: Cache Save
- id: cache-save
- uses: actions/cache/save@v6
- with:
- path: |
- ${{ runner.temp }}/hugo_cache
- key: ${{ steps.cache-restore.outputs.cache-primary-key }}
- - name: Upload artifact
- uses: actions/upload-pages-artifact@v5
- with:
- path: ./docs/public
+ path: docs
deploy:
if: github.repository == 'ChrisTitusTech/winutil'
diff --git a/.gitignore b/.gitignore
index 038c7354..712df037 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,7 +14,7 @@ desktop.ini
.vscode/
.idea/
-# hugo files
-docs/public/
-docs/.hugo_build.lock
-docs/resources/
+# hugo files (archived docs)
+docs-old/public/
+docs-old/.hugo_build.lock
+docs-old/resources/
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..6240da8b
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..1b7f5c3d
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,49 @@
+# Starlight Starter Kit: Basics
+
+[](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+> π§βπ **Seasoned astronaut?** Delete this file. Have fun!
+
+## π Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+βββ public/
+βββ src/
+β βββ assets/
+β βββ content/
+β β βββ docs/
+β βββ content.config.ts
+βββ astro.config.mjs
+βββ package.json
+βββ tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## π§ Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command | Action |
+| :------------------------ | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:4321` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI |
+
+## π Want to learn more?
+
+Check out [Starlightβs docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md
deleted file mode 100644
index 3e72f68c..00000000
--- a/docs/archetypes/default.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: '{{ replace .File.ContentBaseName "-" " " | title }}'
-description: ""
-date: '{{ .Date }}'
-draft: true
----
diff --git a/docs/assets/images/Fork-Button-Light.png b/docs/assets/images/Fork-Button-Light.png
deleted file mode 100644
index 11d56fea035a11501900051134be86b3400ef412..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 22924
zcmdqIbx>qY)8IS64DRmk&fq?{!{F{VxVyW%yAAH{?(Wb) o $~pj%|9wyl1Li+U9~VL}0oR5Q5)@vOaJ+
zF0Z-&<5+SUVM*a)7QrOs#r-8j?SNsal`;NiF`w@Ci+G88UZDnI7lYt+cRKa&em_PS
z8J`jm&;Z}s@>i%w*Zpk3)~()%Cgzs=E(X_|DlyOa=T7*HH!V`xLpFDylE%`Kg_0pf
z8DHwRijH3gF^P4j$+tF$XPV1(7QQ3yin0TZN&zInzTd2bt-GO=PKolT(4AIn*{ytt
z)(<;@(=@`_+LRY=`x4S{RmHoZBiz@0N>1;BwOz9UZdO*>{%?B4^V@*1c}a)KXmRTl
zAYW^iy~kJn>FA_jmQwpEK54{@>e0-wWivx|gL15t_2oMLQvLqJD#&ebuF*s%c9n#`
zf#RTcX@1qMk*cccO-noC)wZ1e3oguIc*e5vc}wFkoR~?StU*&G8;~=k>c~3RS5^1(
zH2eW=sjcS>6Byyccy`_}b8;q61s@38@ou&%F5PWS3Ho+IFdCmu!OcxTRhnjN+YnOR
zPLr91mp5-VI9Lg_S*Jp7QJ*v(R}e0l2!bpr6)DNAuw?ngc(%FYak?ucLO9JVVUC8;
zCyg2fOC*+ih&ie%o(#Qvn;CtI-*gRHmi-EvtB!8VEgis1jf#S^Y-Ahz<8>|%Q|OLw
zR)X*k3OHhAgkP!|aqGVz`Gs}8cEmqRJ>05w`dqZ#tZtOLTyrgeSHypDUDRX$#dYB~
zG(_UkYB!=gY&@$?s0xxq8wN$uHK3UQQpa=A#2P#Lz{x#Kl{nmfU2cO>aF6@dES@l)
zR)wXq QA@V0onIaWo6E_`P1I9uW(=u5Uir5L(~H=nlnTRQ%x&bS
z`sOVtH_miD?d86s^(K0@^WmW92RBvQ=)Q6CpCR0Bu)?O?9#RU0
zNXJyw+i|I^$6{Q>Tr;#x!};^hW-RUF%tpBvay+)z9?V?pHWua?*u`9SweW#MMx_cJRvg_+enp
z8XG!YkSupcQTx1>IlrOdo)>>Q<{Vy!KA19TEZGJcP;x#!D%4eol+cB@ZmW>nG@^s5
zDQk2rU{b-luZqxF2#haE3k?RBOHbltO+~J4-0KEma#Lw!Aht<7sb5^C66W7~n|*!c
zCu$ksD;xPdv1{+|09`i?&zCjb*9qeL-4~0T`3)zI4d
;e+91b!?%=D>>PVJsON+bqx07K+tXElAgCvu+jJCJ?&S1P
ztON~>T$H~gjzw8`%ny9?JwFg!8gU+f{)q(MpSgbOq%_txmw~v)To>07*WCEAHU#=9
zxC@W}`VDSIkVe!~l`w+y*4kCEUDq7HiR?y5^5@T?!I%uGJ|$H_Rl8@#)B{Wl@+gwQ
zB3n)dZv(4m0}pT(&hT0?Mt>lb()VI(v|M#fU7aSCSc=|X66Bfbb2*U|%u~_;+naoo
znI6Qqod$4aK?}$}E3Mf|a;-QHl_jyIj1M?jeW1PSDLF^(Ewg1p)>$h}ccSt>-9Izx
zuZ=y?c^E*_Y?bN^EtS_%#XZ|(L?-u_=sTZtbK%;Sfb}~dryWH&D}2M|AZo?)v(E{98EHO);!{Eb|U=;
zAg2e|R8EXwVwfz}Yf(^wW_ReQqOi4K-{rGD<>gVGZ>f#P{A;!RntD%kvqN+`MO=2A
zb*~Hwz(2XBcTWX_7Q+)&?m5>XL~HNXJd?UrfM2$|vFvZV0Q=;uaw>l;AopN;x>hJX
zt-NKFY}F?lO_ho~eO-x_b(r3R&bhfj`ZzU$`6$z90ISmZG&a%E(&-9fKQ%Encl-_}
zdGDCs(9pQW&@xm%jIv}X5F${_mt?PDFk0-|gF}TKgZbz}Yw%%~$MCF5No6_7ch&^H
ze`eKLrT>4qy+!s<*jAk09=(jH)h7zi&_*G^8*Q^+s`5hthbAQm(5HfDRg6=8)|sQa
zF|E%Y=S2$rXH%K=IG;TE>D2JLfH=9J*ly9rRVi|8)$vE)J)(?
i~jaj2so3Fjy2>3N{hX3lq9-`YztZx4<3@9}t2!HokGGuFso!w{*=WI=2?(?CsQ9BQa)Kp_3i!^Zb%Vd7J6v?{`MmhNlg_TY>%kzV8@jKY!jXS
zv@{xvxp-O{lD<93rt%%UBK7y^*$Wt_agXj;SAFYLU?k|}oHC3Obh6|p;r?P9XC