Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @CodingWonders @Real-MullaC
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Pull Request
description: File a structured PR to help us review faster
title: "[PR]: "
labels: ["needs-review"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to contribute!
- type: checkboxes
id: type-of-change
attributes:
label: Type of Change
options:
- label: New feature
- label: Bug fix
- label: Documentation update
- label: UI/UX improvement
- type: textarea
id: description
attributes:
label: Description
description: What does this PR do?
placeholder: Summarize your changes here...
validations:
required: true
- type: input
id: issue-number
attributes:
label: Issue Related to PR
description: List the issue number (e.g., #123)
placeholder: "Resolves #"
validations:
required: true
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -403,4 +403,9 @@ FodyWeavers.xsd

# JetBrains software
.idea/
MicroWin_DT/
MicroWin_DT/

# Hugo Files
docs/public/
docs/.hugo_build.lock
docs/resources/
6 changes: 6 additions & 0 deletions Docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: '{{ replace .File.ContentBaseName "-" " " | title }}'
description: ""
date: '{{ .Date }}'
draft: true
---
16 changes: 16 additions & 0 deletions Docs/content/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
toc: true
---

## Contributing to the repository

**Requirements:**
- Visual Studio 2026
- .NET Desktop development workload

To contribute to the repository:

1. Fork the repository and clone said fork
2. Open the project
3. Make your changes **AND TEST THEM**
4. Create a pull request
5 changes: 5 additions & 0 deletions Docs/content/KnownIssues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Known Issues
toc: true
---

23 changes: 23 additions & 0 deletions Docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Welcome to MicroWin Documentation!
toc: false
width: full
---

## About MicroWin

**MicroWin** is a Windows system customization and optimization tool written in C#. It's a continuation and rewrite of the popular MicroWin project that was originally integrated into WinUtil. The tool allows advanced users to:

- **Debloat Windows** by removing store apps, features, and unnecessary software
- **Optimize system performance** through registry modifications and service management
- **Customize Windows** to suit specific needs and preferences
- **Create customized Windows images** using DISM and other system tools

The project is currently in **ALPHA** stages and designed for users with Windows systems administration knowledge. It requires administrator privileges to run and provides a GUI-based interface for managing complex system modifications on Windows 10 and Windows 11.

> [!WARNING]
> **DISCLAIMER:** Only use this project if you know what you're doing! If you don't have experience with Windows systems management, please do not use this software. It can make significant changes to your Windows installation.

Explore the documentation to learn more about getting started, the architecture, and contributing to the project.


12 changes: 12 additions & 0 deletions Docs/content/dev/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Developer Reference
weight: 3
toc: false
---

> [!NOTE]
> This section contains technical documentation for developers. For end-user documentation, see the [User Guide](../userguide/).

## Architecture

- [Architecture & Design](architecture/) - Code structure, data flow, and how Microwin works internally
6 changes: 6 additions & 0 deletions Docs/content/dev/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Architecture & Design
weight: 1
toc: true
---

5 changes: 5 additions & 0 deletions Docs/content/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Frequently Asked Questions
toc: true
---

16 changes: 16 additions & 0 deletions Docs/content/userguide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: User Guide
weight: 2
---

## Usage

**HUGE DISCLAIMER: ONLY USE THIS PROJECT IF YOU KNOW WHAT YOU'RE DOING!!! IF YOU EITHER DON'T KNOW WHAT YOU'RE DOING, OR YOU DON'T KNOW WINDOWS SYSTEMS MANAGEMENT, DO NOT USE THIS SOFTWARE.** Grab [DISMTools](https://github.com/CodingWonders/DISMTools) if you want to learn systems management. Please.

1. Download the latest release
2. Extract it
3. Run the tool as an administrator

> [!NOTE]
> The application is not signed with code-signing certificates because of how expensive these are. Please turn off your antivirus or add an exclusion. We don't want any issue reports of that topic.

4 changes: 4 additions & 0 deletions Docs/content/userguide/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Getting Started with Microwin
weight: 1
---
5 changes: 5 additions & 0 deletions Docs/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/CodingWonders/MicroWin

go 1.23.3

require github.com/imfing/hextra v0.11.1 // indirect
2 changes: 2 additions & 0 deletions Docs/go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github.com/imfing/hextra v0.11.1 h1:8pTc4ReYbzGTHAnyiebmlT3ijFfIXiGu1r7tM/UGjFI=
github.com/imfing/hextra v0.11.1/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=
109 changes: 109 additions & 0 deletions Docs/hugo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
baseURL = "example.com"
languageCode = "en-us"
title = "Microwin Documentation"
enableGitInfo = true
canonifyURLs = true

[[module.mounts]]
source = "assets"
target = "assets"

[[module.imports]]
path = "github.com/imfing/hextra"

[[menu.main]]
name = "Developer Documentation"
pageRef = "/dev"
weight = 1

[[menu.main]]
name = "User Guides"
pageRef = "/userguide"
weight = 2

[[menu.main]]
name = "Contribution Guides"
pageRef = "CONTRIBUTING.md"
weight = 3

[[menu.main]]
name = "FAQ"
pageRef = "faq.md"
weight = 4

[[menu.main]]
name = "Known Issues"
pageRef = "KnownIssues.md"
weight = 4

[[menu.main]]
name = "Search"
weight = 6

[menu.main.params]
type = "search"

[[menu.main]]
name = "GitHub"
weight = 7
url = "https://github.com/CodingWonders/MicroWin"

[menu.main.params]
icon = "github"

[params]
description = "Microwin Windows Utility - Customize Your windows iso"
displayUpdatedDate = true
dateFormat = "January 2, 2006"

[params.navbar]
displayTitle = false
displayLogo = true

[params.navbar.logo]
path = "navlogo.png"
dark = "navlogo.png"
link = "/"
width = 150
height = 50

[params.theme]
default = "system"
displayToggle = true

[params.page]
width = "wide"

[params.footer]
enable = true
displayCopyright = true
displayPoweredBy = false
width = "normal"

[params.highlight.copy]
enable = true
display = "hover"

[menu]

[[menu.sidebar]]
name = "Links"
weight = 1
[menu.sidebar.params]
type = "separator"

[[menu.sidebar]]
name = "Github Repo ↗"
url = "https://github.com/CodingWonders/MicroWin"
weight = 2

[[menu.sidebar]]
name = "Discord Server ↗"
url = ""
weight = 3


[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
24 changes: 24 additions & 0 deletions Docs/i18n/en.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
copyright: "&copy; <script>document.write(new Date().getFullYear())</script> Microwin. All rights reserved."

backToTop: "Scroll to top"
changeLanguage: "Change language"
changeTheme: "Change theme"
copy: "Copy"
copied: "Copied!"
copyAsMarkdown: "Copy as Markdown"
copyPage: "Copy Page"
copyCode: "Copy code"
dark: "Dark"
editThisPage: "Edit this page on GitHub →"
lastUpdated: "Last updated on"
light: "Light"
next: "Next"
noResultsFound: "No results found."
onThisPage: "On this page"
poweredBy: ""
previous: "Prev"
readMore: "Read more →"
searchPlaceholder: "Search..."
system: "System"
tags: "Tags"
viewAsMarkdown: "View as Markdown"
17 changes: 17 additions & 0 deletions Docs/layouts/shortcodes/autolinks.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{{- $section := .Get "section" | lower -}}
{{- $pages := slice -}}
{{- range .Site.RegularPages -}}
{{- if in .RelPermalink $section -}}
{{- $pageTitle := .Title -}}
{{- if eq $pageTitle "" -}}
{{- $pageTitle = .File.BaseFileName | humanize | title -}}
{{- end -}}
{{- $pageDesc := .Description -}}
{{- $pages = $pages | append (dict "title" $pageTitle "description" $pageDesc "url" .RelPermalink) -}}
{{- end -}}
{{- end -}}
<ul>
{{- range sort $pages "title" "asc" }}
<li><a href="{{ .url }}">{{ .title }}</a>{{ with .description }} - {{ . }}{{ end }}</li>
{{- end }}
</ul>
Loading