mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2026-08-12 02:51:16 +10:00
Fix alignment issues, update links, and enhance documentation (#4898)
* Fix the same arrow-icon alignment issue on the "Read the Docs" button
Same root cause as the hero/final-CTA buttons: the label was plain
markdown text, which MDX wrapped in a <p>, and the icon was missing
the size/nudge applied elsewhere. Match it to the other two buttons.
* Rename known-issues page slug to knownissues
Update the sidebar config, nav dropdown, and every internal link that
pointed at /known-issues/ to match.
* Fix image paths in root-level markdown to match the new docs site
The Hugo docs site (docs/assets/images/...) has been replaced by the
Astro site (docs/src/assets/...); update CONTRIBUTING.md,
READMEITALIAN.md, and README.md to point at the new asset locations.
* Remove unused houston.webp asset
Leftover Starlight default-theme asset with no references anywhere
in the docs site.
* Fix docs site reference in generator docs
Updates `tools/devdocs-generator.md` to describe link generation correctly: links now point to the Astro/Starlight documentation site instead of the old Hugo site.
* Point docs homepage CTAs to guides hub
Updates the docs landing page CTA links to use `/guides/` instead of `/guides/getting-started/` in the hero action and both “Get Started”/“Read the Docs” buttons, routing users to the guides index.
* Add reusable YouTube embeds to docs guides
Introduces a new `YouTubeEmbed.astro` component for responsive 16:9 video embeds using the privacy-enhanced `youtube-nocookie.com` domain. The User Guide index and Tweaks guide now import and use this component instead of plain YouTube links, and the component includes styling that overrides Starlight’s iframe reset so embedded videos render at the correct size.
* Fix YouTube embed iframe height via not-content
Add the `not-content` class to the embed wrapper so Starlight's markdown reset no longer overrides `iframe { height: auto }`. Drop the `@layer starlight.core` wrapper and `!important` overrides that were compensating for the same issue.
* Clarify docs comments across Astro components
Adds and refines inline comments in the docs site config, custom Starlight components, and theme styles to better explain layout structure, navigation dropdown behavior, hero composition, and theme initialization. Also normalizes a few multi-line comments into single-line form for readability without changing functionality.
* Set secondary docs button background color
Update `.wu-btn-secondary` in the docs theme to use `var(--sl-color-gray-6)` instead of a transparent background, improving button visibility and contrast while keeping existing border and hover behavior.
* Move User Guides into docs dropdown
Updates the docs header navigation so the “User Guides” link is grouped under the existing “Documentation” dropdown instead of appearing as a separate top-level nav item. This keeps related documentation links together and simplifies the top navigation.
* Fix hero margin and center trust section
Remove the automatic 1.5rem top margin Starlight adds between the hero and the content column. Also flex-center the trust section so its content is properly aligned.
* Disable edit links in generated dev docs
Update `tools/devdocs-generator.ps1` to include `editUrl: false` in the frontmatter for generated tweak and feature docs pages. This prevents Starlight from showing edit links on these auto-generated pages.
* Move docs update PRs to pre-release flow
The docs Pages workflow is simplified to only build and deploy the docs site: it now triggers only on docs changes, drops extra permissions/default shell settings, and removes the dev-docs generation + auto-PR steps. The pre-release workflow now owns that automation by expanding its PR step to include generated code-reference docs alongside JSON link updates, with updated commit/title/body text and a documentation label.
* Shorten generated docs source note
Simplify the autogenerated DevDocs notice so generated pages only warn against direct edits while still linking back to the source file.
* Improve docs header dropdown behavior
Reworked the header nav dropdown triggers to use native `<details>/<summary>` instead of buttons, then updated menu visibility logic to use `details[open]` for no-JS support on touch and keyboard while preserving hover behavior. Also renamed the “Developer Docs” link to “Code Reference” and tightened related CSS comments.
* Refresh contribution and docs workflow docs
Updated contributor-facing docs to use consistent Markdown admonition blocks, cleaned Mermaid fence formatting, and fixed minor wording/capitalization in contribution steps. Clarified `devdocs-generator` behavior so workflow ownership is explicit: generation now documented as part of `pre-release.yaml` (via docs-update PR), while `docs.yaml` is documented as build/deploy only.
* Fix contributing guide grammar
Correct the "it's" to "its" typo in both contributing guides so the pull request guidance is consistent across the GitHub and docs versions.
This commit is contained in:
Sean (ANGRYxScotsman)
@@ -28,7 +28,7 @@ irm https://christitus.com/windev | iex
|
||||
* If you're doing code changes, then you can submit a PR to the `main` branch.
|
||||
|
||||
:::caution
|
||||
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S OWN PULL REQUEST!
|
||||
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE ITS OWN PULL REQUEST!
|
||||
:::
|
||||
|
||||
:::caution
|
||||
@@ -114,7 +114,7 @@ While you can make your changes directly through the Web, we recommend cloning t
|
||||
|
||||
|
||||
|
||||
* Push the changes to upload them to your fork on github.com.
|
||||
* Push the changes to upload them to your fork on GitHub.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -314,7 +314,7 @@ WinUtil itself uses about 50-100 MB while running. Once closed, it is removed fr
|
||||
|
||||
Can't find your answer? Try these resources:
|
||||
|
||||
- **[Known Issues](/known-issues/)** — Check if it's a known problem
|
||||
- **[Known Issues](/knownissues/)** — Check if it's a known problem
|
||||
- **[User Guide](/guides/getting-started/)** — Comprehensive documentation
|
||||
- **[Discord Community](https://discord.gg/RUbZUZyByQ)** — Get help from other users
|
||||
- **[GitHub Issues](https://github.com/ChrisTitusTech/winutil/issues)** — Report bugs
|
||||
|
||||
@@ -225,7 +225,7 @@ If the launch command fails:
|
||||
- Retry from a normal PowerShell session rather than a restricted enterprise shell profile.
|
||||
- If the command starts and then closes immediately, reopen Terminal as Administrator and run it again so you can read the error output.
|
||||
|
||||
If it still fails, check the [Known Issues](/known-issues/) page.
|
||||
If it still fails, check the [Known Issues](/knownissues/) page.
|
||||
|
||||
## Next steps
|
||||
|
||||
@@ -240,7 +240,7 @@ Now that you're set up, explore these guides:
|
||||
If you need assistance:
|
||||
|
||||
- **Documentation**: Browse this documentation site
|
||||
- **Known Issues**: Check the [Known Issues](/known-issues/) page
|
||||
- **Known Issues**: Check the [Known Issues](/knownissues/) page
|
||||
- **Discord**: Join the [community Discord server](https://discord.gg/RUbZUZyByQ)
|
||||
- **GitHub Issues**: Report bugs on [GitHub](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
- **YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
@@ -5,6 +5,8 @@ sidebar:
|
||||
order: 0
|
||||
---
|
||||
|
||||
import YouTubeEmbed from '../../../components/YouTubeEmbed.astro';
|
||||
|
||||
Welcome to the official User Guide for **Winutil**, your all-in-one Windows toolkit.
|
||||
|
||||
:::caution
|
||||
@@ -125,7 +127,7 @@ Need help?
|
||||
|
||||
- **Documentation**: You're reading it. Use the navigation menu.
|
||||
- **FAQ**: Check [Frequently Asked Questions](/faq/)
|
||||
- **Known Issues**: Review [Known Issues](/known-issues/)
|
||||
- **Known Issues**: Review [Known Issues](/knownissues/)
|
||||
- **Discord**: Join the [community Discord](https://discord.gg/RUbZUZyByQ)
|
||||
- **GitHub**: Report bugs on [GitHub Issues](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
- **YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
@@ -144,7 +146,9 @@ Want to help improve Winutil?
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
Watch the complete WinUtil overview: [https://www.youtube.com/watch?v=6UQZ5oQg8XA](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
Watch the complete WinUtil overview:
|
||||
|
||||
<YouTubeEmbed id="6UQZ5oQg8XA" title="WinUtil overview" />
|
||||
|
||||
Ready to get started? Head to the **[Getting Started Guide](/guides/getting-started/)**.
|
||||
|
||||
|
||||
@@ -5,6 +5,8 @@ sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
import YouTubeEmbed from '../../../components/YouTubeEmbed.astro';
|
||||
|
||||
|
||||
|
||||
Use the Tweaks tab to apply recommended Windows changes, review optional presets, and adjust a few supporting settings such as DNS and power plans. Start with a preset unless you already know which individual tweaks you want.
|
||||
@@ -53,7 +55,9 @@ Advanced Tweaks are for users who understand the side effects of deeper Windows
|
||||
### O&O ShutUp10++
|
||||
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from WinUtil with one click. It is a free privacy tool for Windows that helps users manage telemetry, update behavior, and app permission settings.
|
||||
|
||||
Watch a walkthrough: [https://www.youtube.com/watch?v=3HvNr8eMcv0](https://www.youtube.com/watch?v=3HvNr8eMcv0)
|
||||
Watch a walkthrough:
|
||||
|
||||
<YouTubeEmbed id="3HvNr8eMcv0" title="O&O ShutUp10++ walkthrough" />
|
||||
|
||||
### DNS
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ hero:
|
||||
file: ../../assets/branding/title-screen.png
|
||||
actions:
|
||||
- text: Get Started
|
||||
link: /guides/getting-started/
|
||||
link: /guides/
|
||||
icon: right-arrow
|
||||
- text: View on GitHub
|
||||
link: https://github.com/ChrisTitusTech/winutil
|
||||
@@ -156,9 +156,9 @@ import CornerCard from '../../components/CornerCard.astro';
|
||||
</div>
|
||||
</div>
|
||||
<div class="wu-cta" style="margin-top: 3rem;">
|
||||
<a class="wu-btn wu-btn-secondary" href="/guides/getting-started/">
|
||||
Read the Docs
|
||||
<Icon name="right-arrow" />
|
||||
<a class="wu-btn wu-btn-secondary" href="/guides/">
|
||||
{'Read the Docs'}
|
||||
<Icon name="right-arrow" size="1.5em" class="wu-icon-arrow" />
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -185,7 +185,7 @@ import CornerCard from '../../components/CornerCard.astro';
|
||||
<h2>Stop hunting for the same fixes every time</h2>
|
||||
<p>Get a script that installs, tweaks, fixes, and updates Windows from one window.</p>
|
||||
<div class="wu-btn-row">
|
||||
<a class="wu-btn wu-btn-primary" href="/guides/getting-started/">
|
||||
<a class="wu-btn wu-btn-primary" href="/guides/">
|
||||
{'Get Started'}
|
||||
<Icon name="right-arrow" size="1.5em" class="wu-icon-arrow" />
|
||||
</a>
|
||||
|
||||
Reference in New Issue
Block a user