Adds all files for winutil docs

This commit is contained in:
hubster-bot 2024-07-12 16:31:05 +01:00
parent af1743066f
commit a2d4922b0f
11 changed files with 129 additions and 0 deletions

23
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,23 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- uses: actions/cache@v2
with:
key: ${{ github.ref }}
path: .cache
- run: pip install mkdocs-material
- run: pip install pillow cairosvg
- run: mkdocs gh-deploy --force

17
.github/workflows/createchangelog.yml vendored Normal file
View File

@ -0,0 +1,17 @@
name: On release published
on:
release:
types: [published]
jobs:
changelog:
name: Update changelog
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: main
- uses: rhysd/changelog-from-release/action@v3
with:
file: /docs/updates.md
github_token: ${{ secrets.GITHUB_TOKEN }}

16
docs/contribute.md Normal file
View File

@ -0,0 +1,16 @@
# How to Contribute?
## Testing your changes
* Once you think you are ready to make a PR to the Main WinUtil branch. Test it. You are probably asking how do I test it?
* To test to see if your changes work run the command below in a powershell terminal as Admin after changing to the directory where the WinUtil code is located.
* `./Compile.ps1`
* After running that command and it completeing with no errors run the command below.
* `./winutil.ps1`
* After seeing that your chnages work properly feel free to make a PR and follow the documentation below.
## Making a PR
* Once you think you are ready to make a PR to the Main WinUtil branch and have tested it. You are probably asking how do I make 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 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 in 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. As all new changes go into the /windev build to make sure everything is working ok before going fully public.
* Congrats you just submitted your first PR. Thank you so much for contributing to WinUtil.

4
docs/faq.md Normal file
View File

@ -0,0 +1,4 @@
# FAQ's
## How do I uninstall WinUtil?
* You do not have to uninstall WinUtil. As it is a script you run from Powershell it only loads into your RAM. This means as soon as you close WinUtil it will be deleted off your system.

BIN
docs/img/ProgramInstall.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

BIN
docs/img/favicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

10
docs/index.md Normal file
View File

@ -0,0 +1,10 @@
# Welcome to Chris Titus WinUtil Docs!
## Running
There are 2 ways to run WinUtil. The 2 ways goes as follows:
* `irm christitus.com/win | iex` - Runs WinUtil from ChrisTitus website using main branch.
* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1 | iex` - Runs WinUtil from github using main branch.
* `irm christitus.com/windev | iex` - Runs WinUtil from ChrisTitus website using dev branch.
* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/windev.ps1 | iex` - Runs WinUtil from github using dev branch.

3
docs/updates.md Normal file
View File

@ -0,0 +1,3 @@
# Update Log
#

18
docs/userguide.md Normal file
View File

@ -0,0 +1,18 @@
# User Guide
## Program Installation
* To install programs select the programs you wish to install like the picture below.
![Program Install](img/ProgramInstall.png)
* Once you have selected the programs you wish to install click the select Install/Upgrade Selected button as seen below.
![Program Install Button](img/ProgramInstallButton.png)
## Program Updates
* To update programs select the programs you wish to update like the picture below.
![Program Install](img/ProgramInstall.png)
* Once you have selected the programs you wish to update click the select Install/Upgrade Selected button as seen below.
![Program Install Button](img/ProgramInstallButton.png)
## Program Uninstall
* To uninstall programs select the programs you wish to uninstall like the picture below.
![Program Install](img/ProgramInstall.png)
* Once you have selected the programs you wish to uninstall click the select Uninstall Selected button as seen below.

38
mkdocs.yml Normal file
View File

@ -0,0 +1,38 @@
site_name: Chris Titus WinUtil Docs
repo_url: https://github.com/ChrisTitusTech/winutil
nav:
- Introduction: 'index.md'
- User Guide: 'userguide.md'
- Contribute: 'contribute.md'
- Updates: 'updates.md'
- FAQ: 'faq.md'
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- toc.integrate
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotation
- content.code.copy
language: en
logo: img/favicon.png
favicon: img/favicon.png
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
primary: black
accent: purple
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
primary: teal
accent: lime