[Docs 02] Auto dev-docs & more

.github/workflows/compile.yaml

@@ -19,7 +19,9 @@ jobs:
     - name: Compile project
       shell: pwsh
       run: |
-        Set-ExecutionPolicy Bypass -Scope Process -Force; ./Compile.ps1
+        Set-ExecutionPolicy Bypass -Scope Process -Force
+        ./Compile.ps1
+        ./devdocs-generator.ps1
       continue-on-error: false # Directly fail the job on error, removing the need for a separate check
     - name: Create and import code signing certificate
       shell: pwsh

.github/workflows/github-pages.yml

@@ -19,4 +19,6 @@ jobs:
           path: .cache
       - run: pip install mkdocs-material
       - run: pip install pillow cairosvg
+      - run: pip install mkdocs-awesome-pages-plugin
+      - run: pip install mkdocs-git-revision-date-localized-plugin
       - run: mkdocs gh-deploy --force

CODE_OF_CONDUCT.md

@@ -0,0 +1,65 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, documentation edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include posting via an official social media 
+account, or acting as an appointed representative at an online or offline event. 
+Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported. All complaints will be reviewed and investigated and will result 
+in a response that is deemed necessary and appropriate to the circumstances. 
+The project team is obligated to maintain confidentiality with regard to the 
+reporter of an incident. Further details of specific enforcement policies may 
+be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.

CONTRIBUTING.md

@@ -0,0 +1,106 @@
+# How to Contribute?
+
+## Testing
+
+* Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
+
+#### **Run the latest pre-release**
+   ```ps1
+   irm christitus.com/windev | iex
+   ```
+
+!!! bug "Keep in mind"
+
+     This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production!
+
+## Issues
+
+* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs or consider feature requests.
+
+## Contribute Code
+
+* Pull requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
+
+* If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
+
+!!! warning "Important"
+
+     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!
+
+* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied.
+
+* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
+
+!!! note
+
+     When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
+
+## Walk through
+
+* This is a guide for beginners. If you are still having issues, look at the following official GitHub documentation:
+    * [Commit through WEB](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)
+    * [Commit through GitHub Desktop](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)
+    * [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
+
+
+### Overview
+
+``` mermaid
+graph LR
+  A[Fork Project] --> B[Clone Repository];
+  B --> C[Create New Branch];
+  C --> D[Make Changes];
+  D --> G[Test Changes];
+  G --> H{Tests Passed?};
+  H -->|Yes| E[Commit Changes];
+  E --> F[Push Branch];
+  H -->|No| J[Fix Issues];
+  F --> K[Create Pull Request];
+  K --> L[Fill out PR template];
+  J --> G;
+```
+!!! info
+
+     This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
+
+### Fork the Repo
+* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
+![Fork Image](assets/Fork-Button-Dark.png#only-dark)
+![FOrk Image](assets/Fork-Button-Light.png#only-light)
+
+### Clone the Fork
+!!! tip
+
+     While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.
+
+* Install GitHub Desktop if it is not already installed.
+* Log in using the same GitHub account you used to fork WinUtil.
+* Choose the fork under "Your Repositories" and press "clone {repo name}"
+* Create a new branch and name it something relatable to your changes.
+
+* Now you can modify WinUtil to your liking using your preferred text editor.
+
+
+### Testing your changes
+
+* To test to see if your changes work as intended run following commands in a powershell teminal as admin:
+
+* Change the directory where you are running the commands to the forked project.
+* `cd {path to the folder with the compile.ps1}`
+* Run the following command to compile and run WinUtil:
+* `.\Compile.ps1 -run`
+* ![Compile](assets/Compile.png)
+* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
+
+### Committing the changes
+* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
+- ![Push Commit Image](assets/Discard-GHD.png)
+* Now, commit your changes once you are happy with the result.
+![Commit Image](assets/Commit-GHD.png)
+* Push the changes to upload them to your fork on github.com.
+![Push Commit Image](assets/Push-Commit.png)
+
+### Making a PR
+* To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.
+* If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.
+* Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.

config/feature.json

@@ -1,7 +1,8 @@
-{
+{
   "WPFFeaturesdotnet": {
     "Content": "All .Net Framework (2,3,4)",
     "Description": ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a010_",
@@ -16,6 +17,7 @@
   "WPFFeatureshyperv": {
     "Content": "HyperV Virtualization",
     "Description": "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a011_",
@@ -36,6 +38,7 @@
   "WPFFeatureslegacymedia": {
     "Content": "Legacy Media (WMP, DirectPlay)",
     "Description": "Enables legacy programs from previous versions of windows",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a012_",
@@ -49,9 +52,10 @@
 
     ]
   },
-  "WPFFeaturewsl": {
+  "WPFFeatureswsl": {
     "Content": "Windows Subsystem for Linux",
     "Description": "Windows Subsystem for Linux is an optional feature of Windows that allows Linux programs to run natively on Windows without the need for a separate virtual machine or dual booting.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a020_",
@@ -63,9 +67,10 @@
 
     ]
   },
-  "WPFFeaturenfs": {
+  "WPFFeaturesnfs": {
     "Content": "NFS - Network File System",
     "Description": "Network File System (NFS) is a mechanism for storing files on a network.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a014_",
@@ -82,9 +87,10 @@
       "nfsadmin client localhost config fileaccess=755 SecFlavors=+sys -krb5 -krb5i"
     ]
   },
-  "WPFFeatureEnableSearchSuggestions": {
+  "WPFFeaturesEnableSearchSuggestions": {
     "Content": "Enable Search Box Web Suggestions in Registry(explorer restart)",
     "Description": "Enables web suggestions when searching using Windows Search.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a015_",
@@ -100,9 +106,10 @@
       "
     ]
   },
-  "WPFFeatureDisableSearchSuggestions": {
+  "WPFFeaturesDisableSearchSuggestions": {
     "Content": "Disable Search Box Web Suggestions in Registry(explorer restart)",
     "Description": "Disables web suggestions when searching using Windows Search.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a016_",
@@ -118,9 +125,10 @@
       "
     ]
   },
-  "WPFFeatureRegBackup": {
+  "WPFFeaturesRegBackup": {
     "Content": "Enable Daily Registry Backup Task 12.30am",
     "Description": "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a017_",
@@ -136,9 +144,10 @@
       "
     ]
   },
-  "WPFFeatureEnableLegacyRecovery": {
+  "WPFFeaturesEnableLegacyRecovery": {
     "Content": "Enable Legacy F8 Boot Recovery",
     "Description": "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a018_",
@@ -154,9 +163,10 @@
       "
     ]
   },
-  "WPFFeatureDisableLegacyRecovery": {
+  "WPFFeaturesDisableLegacyRecovery": {
     "Content": "Disable Legacy F8 Boot Recovery",
     "Description": "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes.",
+    "link": "https://christitustech.github.io/winutil/dev/features/Legacy-Windows-Panels/user",
     "category": "Features",
     "panel": "1",
     "Order": "a019_",
@@ -172,14 +182,14 @@
       "
     ]
   },
-  "WPFFeaturesandbox": {
+  "WPFFeaturessandbox": {
     "Content": "Windows Sandbox",
     "category": "Features",
     "panel": "1",
     "Order": "a021_",
     "Description": "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation."
   },
-  "WPFFeatureInstall": {
+  "WPFFeaturesInstall": {
     "Content": "Install Features",
     "category": "Features",
     "panel": "1",
@@ -285,3 +295,6 @@
     "ButtonWidth": "300"
   }
 }
+
+
+