Add documentation index link to main README

Co-authored-by: salmanmkc <32169182+salmanmkc@users.noreply.github.com>

.github/workflows/build.yml

@@ -50,7 +50,7 @@ jobs:
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     # Build runner layout
     - name: Build & Layout Release

.github/workflows/codeql.yml

@@ -23,7 +23,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/docker-buildx-upgrade.yml

@@ -17,7 +17,7 @@ jobs:
       BUILDX_CURRENT_VERSION: ${{ steps.check_buildx_version.outputs.CURRENT_VERSION }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Check Docker version
         id: check_docker_version
@@ -89,7 +89,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       
       - name: Update Docker version
         shell: bash

.github/workflows/dotnet-upgrade.yml

@@ -15,7 +15,7 @@ jobs:
       DOTNET_CURRENT_MAJOR_MINOR_VERSION: ${{ steps.fetch_current_version.outputs.DOTNET_CURRENT_MAJOR_MINOR_VERSION }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Get current major minor version
         id: fetch_current_version
         shell: bash
@@ -89,7 +89,7 @@ jobs:
     if: ${{ needs.dotnet-update.outputs.SHOULD_UPDATE == 1 && needs.dotnet-update.outputs.BRANCH_EXISTS == 0 }}
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         ref: feature/dotnetsdk-upgrade/${{ needs.dotnet-update.outputs.DOTNET_LATEST_MAJOR_MINOR_PATCH_VERSION }}
     - name: Create Pull Request

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
     if: startsWith(github.ref, 'refs/heads/releases/') || github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     # Make sure ./releaseVersion match ./src/runnerversion
     # Query GitHub release ensure version is not used
@@ -86,7 +86,7 @@ jobs:
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     # Build runner layout
     - name: Build & Layout Release
@@ -129,7 +129,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     # Download runner package tar.gz/zip produced by 'build' job
     - name: Download Artifact (win-x64)
@@ -296,7 +296,7 @@ jobs:
       IMAGE_NAME: ${{ github.repository_owner }}/actions-runner
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Compute image version
         id: image

README.md

@@ -12,28 +12,33 @@ The runner is the application that runs a job from a GitHub Actions workflow. It
 
 For more information about installing and using self-hosted runners, see [Adding self-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/adding-self-hosted-runners) and [Using self-hosted runners in a workflow](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)
 
-Runner releases:
+## Download and Install
 
-![win](docs/res/win_sm.png) [Pre-reqs](docs/start/envwin.md) | [Download](https://github.com/actions/runner/releases)  
+![win](docs/res/win_sm.png) **Windows**: [Prerequisites](docs/start/envwin.md) | [Download](https://github.com/actions/runner/releases)  
 
-![macOS](docs/res/apple_sm.png)  [Pre-reqs](docs/start/envosx.md) | [Download](https://github.com/actions/runner/releases)  
+![macOS](docs/res/apple_sm.png) **macOS**: [Prerequisites](docs/start/envosx.md) | [Download](https://github.com/actions/runner/releases)  
 
-![linux](docs/res/linux_sm.png)  [Pre-reqs](docs/start/envlinux.md) | [Download](https://github.com/actions/runner/releases)
+![linux](docs/res/linux_sm.png) **Linux**: [Prerequisites](docs/start/envlinux.md) | [Download](https://github.com/actions/runner/releases)
 
-### Note
+## Documentation and Resources
 
-Thank you for your interest in this GitHub repo, however, right now we are not taking contributions. 
+- 📚 **[Complete Documentation Index](docs/README.md)** - Comprehensive guide to all documentation
+- 📖 **[Contributing Guide](docs/contribute.md)** - Development setup, building, and testing
+- 🔧 **[Automation Scripts](docs/automate.md)** - Automate runner setup and configuration  
+- 🛠️ **[Troubleshooting Guides](docs/checks/README.md)** - Common issues and solutions
+- 🏗️ **[Architecture Decision Records](docs/adrs/README.md)** - Important architectural decisions
+- ⚙️ **Platform Prerequisites:** [Linux](docs/start/envlinux.md) | [Windows](docs/start/envwin.md) | [macOS](docs/start/envosx.md)
 
-We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features we’re working on and what stage they’re in.
+## Support and Community
 
-We are taking the following steps to better direct requests related to GitHub Actions, including:
+Thank you for your interest in this repository. Please note our current contribution and support guidelines:
 
-1. We will be directing questions and support requests to our [Community Discussions area](https://github.com/orgs/community/discussions/categories/actions)
+**Bug Reports:** You are welcome to report bugs in this repository through Issues.
 
-2. High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.
+**Feature Requests:** Please submit feature and enhancement requests on the [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions) page.
 
-3. Security Issues should be handled as per our [security.md](security.md)
+**Support Questions:** For help and support, please use our [Community Discussions area](https://github.com/orgs/community/discussions/categories/actions).
 
-We will still provide security updates for this project and fix major breaking changes during this time.
+**Security Issues:** Please report security vulnerabilities following our [security policy](security.md).
 
-You are welcome to still raise bugs in this repo.
+**High Priority Issues:** Critical bugs can be reported through Community Discussions or our [support team](https://support.github.com/contact/bug-report).

docs/README.md

@@ -0,0 +1,61 @@
+# GitHub Actions Runner Documentation
+
+Welcome to the GitHub Actions Runner documentation. This guide will help you get started with self-hosted runners, contribute to the project, and troubleshoot common issues.
+
+## 🚀 Getting Started
+
+### Installation and Setup
+- **[Linux Prerequisites](start/envlinux.md)** - Complete setup guide for Linux systems
+- **[Windows Prerequisites](start/envwin.md)** - Complete setup guide for Windows systems  
+- **[macOS Prerequisites](start/envosx.md)** - Complete setup guide for macOS systems
+
+### Quick Start
+1. Download the [latest runner release](https://github.com/actions/runner/releases)
+2. Follow the platform-specific prerequisites guide above
+3. Configure your runner with `./config.sh` (Linux/macOS) or `.\config.cmd` (Windows)
+4. Start the runner with `./run.sh` (Linux/macOS) or `.\run.cmd` (Windows)
+
+## 🔧 Administration and Automation
+
+- **[Automation Scripts](automate.md)** - Automate runner deployment and management
+- **[Troubleshooting Guides](checks/)** - Common issues and solutions
+
+## 🏗️ Development and Contributing
+
+- **[Contributing Guide](contribute.md)** - Development setup, building, and testing
+- **[Architecture Decision Records](adrs/README.md)** - Important architectural decisions and design patterns
+
+## 📋 Reference Materials
+
+### System Checks and Troubleshooting
+- **[Network Connectivity](checks/network.md)** - Troubleshoot network issues
+- **[Git Configuration](checks/git.md)** - Git-related problems
+- **[Actions Troubleshooting](checks/actions.md)** - Action-specific issues
+- **[SSL Certificate Issues](checks/sslcert.md)** - Certificate and TLS problems
+- **[Node.js Issues](checks/nodejs.md)** - Node.js runtime problems
+- **[Internet Connectivity](checks/internet.md)** - General connectivity issues
+
+### Development Resources
+- **[Visual Studio Code Setup](contribute/vscode.md)** - IDE configuration for development
+- **[Design Documentation](design/)** - Technical design documents
+
+## 🆘 Getting Help
+
+### Community Support
+- **[GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)** - Ask questions and get help from the community
+- **[GitHub Support](https://support.github.com/contact/bug-report)** - Report critical bugs or get professional support
+
+### Reporting Issues
+- **Bug Reports**: Open an issue in this repository
+- **Feature Requests**: Use [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions-and-packages)
+- **Security Issues**: Follow our [security policy](../security.md)
+
+## 📖 Additional Resources
+
+- **[GitHub Actions Documentation](https://docs.github.com/en/actions)** - Official GitHub Actions documentation
+- **[Self-hosted Runners Guide](https://docs.github.com/en/actions/hosting-your-own-runners)** - GitHub's official self-hosted runner documentation
+- **[Runner Releases](https://github.com/actions/runner/releases)** - Download the latest runner versions
+
+---
+
+> **Note**: This documentation is maintained by the GitHub Actions team and the community. If you find any issues or have suggestions for improvement, please open an issue or contribute a pull request.

docs/automate.md

@@ -76,3 +76,76 @@ Repo level one-liner.  NOTE: replace with yourorg/yourrepo (repo level) or just
 ```bash
 curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/delete.sh | bash -s yourorg/yourrepo runnername
 ```
+
+## Troubleshooting
+
+### Common Issues
+
+#### Permission Denied
+```bash
+# Ensure scripts have execute permissions
+chmod +x ./config.sh ./run.sh
+```
+
+#### PAT Token Issues
+```bash
+# Verify your PAT has the correct scopes:
+# - repo (for repository-level runners)
+# - admin:org (for organization-level runners)
+export RUNNER_CFG_PAT=your_token_here
+echo $RUNNER_CFG_PAT  # Verify it's set
+```
+
+#### Network Connectivity
+```bash
+# Test GitHub connectivity
+curl -H "Authorization: token $RUNNER_CFG_PAT" https://api.github.com/user
+
+# For GitHub Enterprise Server
+curl -H "Authorization: token $RUNNER_CFG_PAT" https://your-github-enterprise/api/v3/user
+```
+
+#### Service Installation Fails
+```bash
+# Check if running as appropriate user
+whoami
+
+# For Linux - ensure systemd is available
+systemctl --version
+
+# For macOS - ensure launchd is available
+launchctl version
+```
+
+#### Runner Registration Fails
+```bash
+# Check if runner already exists
+curl -H "Authorization: token $RUNNER_CFG_PAT" \
+  "https://api.github.com/repos/OWNER/REPO/actions/runners"
+
+# Remove existing runner if needed
+./config.sh remove --token $RUNNER_CFG_PAT
+```
+
+### Getting Help
+
+- **Configuration Issues**: Check the [Prerequisites](start/envlinux.md) for your platform
+- **Network Problems**: Review [network troubleshooting guide](checks/network.md)
+- **General Support**: Visit [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)
+
+### Advanced Examples
+
+#### Organization-level Runner with Custom Labels
+```bash
+export RUNNER_CFG_PAT=your_org_pat
+curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | \
+  bash -s -- -s myorg -n prod-runner-1 -l production,linux,docker
+```
+
+#### Repository-level Runner for GitHub Enterprise
+```bash
+export RUNNER_CFG_PAT=your_ghe_pat
+curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | \
+  bash -s -- -s myorg/myrepo -g github.company.com -n build-server -u builder
+```
+```

docs/checks/README.md

@@ -0,0 +1,66 @@
+# Troubleshooting Guides
+
+This directory contains troubleshooting guides for common issues you might encounter when setting up or running GitHub Actions self-hosted runners.
+
+## Quick Reference
+
+| Issue Type | Guide | Description |
+|------------|-------|-------------|
+| 🌐 **Network** | [network.md](network.md) | Connection issues, proxy, firewall problems |
+| 🔒 **SSL/TLS** | [sslcert.md](sslcert.md) | Certificate and TLS handshake issues |
+| 📦 **Git** | [git.md](git.md) | Git configuration and repository access |
+| ⚡ **Actions** | [actions.md](actions.md) | Action-specific runtime issues |
+| 🟢 **Node.js** | [nodejs.md](nodejs.md) | Node.js runtime and npm issues |
+| 🌍 **Internet** | [internet.md](internet.md) | General internet connectivity |
+
+## Common First Steps
+
+Before diving into specific guides, try these general troubleshooting steps:
+
+### 1. Check Basic Connectivity
+```bash
+# Test GitHub API access
+curl -I https://api.github.com/
+
+# For GitHub Enterprise Server
+curl -I https://your-github-enterprise.com/api/v3/
+```
+
+### 2. Verify Runner Status
+```bash
+# Check if runner service is running
+./svc.sh status
+
+# View recent logs
+tail -f _diag/Runner_*.log
+```
+
+### 3. Test Runner Configuration
+```bash
+# Re-run configuration
+./config.sh
+
+# Test connection without running
+./run.sh --check
+```
+
+## Getting Additional Help
+
+If these guides don't resolve your issue:
+
+1. **Search existing issues** in the [runner repository](https://github.com/actions/runner/issues)
+2. **Check GitHub Status** at [githubstatus.com](https://githubstatus.com)
+3. **Ask the community** in [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)
+4. **Contact support** for critical issues via [GitHub Support](https://support.github.com/contact)
+
+## Contributing
+
+Found a solution to a common problem not covered here? Consider contributing:
+
+1. Create a new `.md` file for the issue type
+2. Follow the format of existing guides
+3. Submit a pull request with your improvements
+
+---
+
+💡 **Tip**: Always check the `_diag/` directory for detailed log files when troubleshooting issues.

docs/contribute.md

@@ -1,5 +1,24 @@
 # Contributions
 
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Issues](#issues)
+- [Enhancements and Feature Requests](#enhancements-and-feature-requests)
+- [Required Dev Dependencies](#required-dev-dependencies)
+- [Quickstart: Run a Job from a Real Repository](#quickstart-run-a-job-from-a-real-repository)
+- [Development Life Cycle](#development-life-cycle)
+  - [Clone Repository](#clone-repository)
+  - [Build Layout](#build-layout)
+  - [Test Layout](#test-layout)
+  - [Configure Runner](#configure-runner)
+  - [Run Runner](#run-runner)
+  - [View Logs](#view-logs)
+- [Editors](#editors)
+- [Styling](#styling)
+
+## Getting Started
+
 We welcome contributions in the form of issues and pull requests. We view the contributions and the process as the same for github and external contributors. Please note the runner typically requires changes across the entire system and we aim for issues in the runner to be entirely self contained and fixable here. Therefore, we will primarily handle bug issues opened in this repo and we kindly request you to create all feature and enhancement requests on the [GitHub Feedback](https://github.com/community/community/discussions/categories/actions-and-packages) page. 
 
 > IMPORTANT: Building your own runner is critical for the dev inner loop process when contributing changes.  However, only runners built and distributed by GitHub (releases) are supported in production.  Be aware that workflows and orchestrations run service side with the runner being a remote process to run steps.  For that reason, the service can pull the runner forward so customizations can be lost.
@@ -124,8 +143,8 @@ cd runner/_layout
 ./config.(sh/cmd) # configure your custom runner
 ```
 
-You will need your the name of your repository and a runner registration token.
-Check [Quickstart](##Quickstart:-Run-a-job-from-a-real-repository) if you don't know how to get this token.
+You will need the name of your repository and a runner registration token.
+Check the [Quickstart section](#quickstart-run-a-job-from-a-real-repository) if you don't know how to get this token.
 
 These can also be passed down as arguments to `config.(sh/cmd)`:
 ```bash

docs/start/envlinux.md

@@ -6,10 +6,21 @@
 
 Please see "[Supported architectures and operating systems for self-hosted runners](https://docs.github.com/en/actions/reference/runners/self-hosted-runners#linux)."
 
-## Install .Net Core 3.x Linux Dependencies
+## Quick Setup
+
+The `./config.sh` script will automatically check and guide you through installing .NET dependencies:
+
+```bash
+./config.sh
+# If dependencies are missing, run:
+./bin/installdependencies.sh
+```
+
+## Install .NET Core Linux Dependencies
+
+The `./config.sh` will check .NET Core dependencies during runner configuration.  
+You might see something like this which indicates a dependency is missing:
 
-The `./config.sh` will check .Net Core 3.x dependencies during runner configuration.  
-You might see something like this which indicate a dependency's missing.
 ```bash
 ./config.sh
     libunwind.so.8 => not found
@@ -17,34 +28,87 @@ You might see something like this which indicate a dependency's missing.
 Dependencies is missing for Dotnet Core 6.0
 Execute ./bin/installdependencies.sh to install any missing Dotnet Core 6.0 dependencies.
 ```
+
 You can easily correct the problem by executing `./bin/installdependencies.sh`.  
 The `installdependencies.sh` script should install all required dependencies on all supported Linux versions  
-> Note: The `installdependencies.sh` script will try to use the default package management mechanism on your Linux flavor (ex. `yum`/`apt-get`/`apt`).
 
-### Full dependencies list
+> **Note:** The `installdependencies.sh` script will try to use the default package management mechanism on your Linux flavor (ex. `yum`/`apt-get`/`apt`).
 
-Debian based OS (Debian, Ubuntu, Linux Mint)
+## Manual Dependency Installation
 
+If the automatic installation doesn't work, you can manually install dependencies using your package manager:
+
+### Debian based OS (Debian, Ubuntu, Linux Mint)
+
+```bash
+sudo apt-get update
+sudo apt-get install -y liblttng-ust1 libkrb5-3 zlib1g libssl1.1 libicu66
+```
+
+**Required packages:**
 - liblttng-ust1 or liblttng-ust0
 - libkrb5-3
 - zlib1g
 - libssl1.1, libssl1.0.2 or libssl1.0.0
 - libicu63, libicu60, libicu57 or libicu55
 
-Fedora based OS (Fedora, Red Hat Enterprise Linux, CentOS, Oracle Linux 7)
+### Fedora based OS (Fedora, Red Hat Enterprise Linux, CentOS, Oracle Linux 7)
 
+```bash
+sudo yum install -y lttng-ust openssl-libs krb5-libs zlib libicu
+# Or for newer systems:
+sudo dnf install -y lttng-ust openssl-libs krb5-libs zlib libicu
+```
+
+**Required packages:**
 - lttng-ust
 - openssl-libs
 - krb5-libs
 - zlib
 - libicu
 
-SUSE based OS (OpenSUSE, SUSE Enterprise)
+### SUSE based OS (OpenSUSE, SUSE Enterprise)
 
+```bash
+sudo zypper install -y lttng-ust libopenssl1_1 krb5 zlib libicu60_2
+```
+
+**Required packages:**
 - lttng-ust
 - libopenssl1_1
 - krb5
 - zlib
 - libicu60_2
 
-## [More .Net Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x)
+## Troubleshooting
+
+### Common Issues
+
+**Permission denied errors:**
+```bash
+sudo chmod +x ./config.sh ./run.sh
+```
+
+**Missing dependencies after installation:**
+```bash
+# Check what's missing
+ldd ./bin/Runner.Listener
+# Reinstall dependencies
+./bin/installdependencies.sh
+```
+
+**SSL/TLS errors:**
+```bash
+# Update certificates
+sudo apt-get update && sudo apt-get install ca-certificates
+# Or for RHEL/CentOS:
+sudo yum update ca-certificates
+```
+
+### Getting Help
+
+- Check our [troubleshooting guide](../checks/README.md)
+- Search [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)
+- Review [common network issues](../checks/network.md)
+
+## [More .NET Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x)

docs/start/envosx.md

@@ -1,9 +1,136 @@
 
 
-# ![osx](../res/apple_med.png) macOS/OS X System Prerequisites
+# ![osx](../res/apple_med.png) macOS System Prerequisites
 
 ## Supported Versions
 
 Please see "[Supported architectures and operating systems for self-hosted runners](https://docs.github.com/en/actions/reference/runners/self-hosted-runners#macos)."
 
-## [More .Net Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/macos-prerequisites?tabs=netcore30)
+## Quick Setup
+
+1. **Download** the latest runner from [releases](https://github.com/actions/runner/releases)
+2. **Extract** the downloaded archive: `tar xzf actions-runner-osx-x64-*.tar.gz`
+3. **Run** `./config.sh` to configure the runner
+4. **Install** as a service: `sudo ./svc.sh install` and `sudo ./svc.sh start`
+
+## System Requirements
+
+### macOS Version
+- macOS 10.15 (Catalina) or later
+- Both Intel (x64) and Apple Silicon (ARM64) are supported
+
+### Required Tools
+
+#### Homebrew (Recommended)
+Install Homebrew for easy package management:
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+#### Development Tools
+```bash
+# Install Xcode Command Line Tools
+xcode-select --install
+
+# Install essential development tools via Homebrew
+brew install git curl wget
+```
+
+### .NET Runtime
+- .NET 6.0 runtime (automatically included with the runner)
+
+## Setup Steps
+
+### 1. Download and Extract
+```bash
+# Create runner directory
+mkdir ~/actions-runner && cd ~/actions-runner
+
+# Download latest release (replace with actual version)
+curl -O -L https://github.com/actions/runner/releases/download/v2.xyz.z/actions-runner-osx-x64-2.xyz.z.tar.gz
+
+# Extract
+tar xzf ./actions-runner-osx-x64-2.xyz.z.tar.gz
+```
+
+### 2. Configure
+```bash
+./config.sh --url https://github.com/YOUR_ORG/YOUR_REPO --token YOUR_TOKEN
+```
+
+### 3. Run as Service (macOS)
+```bash
+# Install as launchd service
+sudo ./svc.sh install
+
+# Start the service
+sudo ./svc.sh start
+
+# Check status
+sudo ./svc.sh status
+```
+
+### 4. Run Interactively (Alternative)
+```bash
+./run.sh
+```
+
+## macOS-Specific Considerations
+
+### Security & Privacy
+- Allow the runner executable through macOS Gatekeeper
+- Grant necessary permissions in System Preferences > Security & Privacy
+
+### Code Signing
+For repositories that build macOS applications:
+```bash
+# Install certificates for code signing
+security import developer_certificates.p12 -k ~/Library/Keychains/login.keychain
+```
+
+### Xcode Integration
+If building iOS/macOS apps:
+```bash
+# Install Xcode from App Store or developer portal
+# Set Xcode path
+sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**Permission Denied:**
+```bash
+chmod +x ./config.sh ./run.sh ./svc.sh
+```
+
+**Gatekeeper Issues:**
+```bash
+# Allow unsigned binary to run
+sudo spctl --master-disable
+# Or specifically allow the runner
+sudo spctl --add ./bin/Runner.Listener
+```
+
+**Service Not Starting:**
+```bash
+# Check system logs
+sudo ./svc.sh status
+tail -f ~/Library/Logs/Runner_*.log
+```
+
+**Path Issues:**
+```bash
+# Ensure proper PATH in your shell profile
+echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+### Getting Help
+
+- Check our [troubleshooting guide](../checks/README.md)
+- Review [common network issues](../checks/network.md)
+- Search [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)
+
+## [More .NET Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/macos-prerequisites?tabs=netcore30)

docs/start/envwin.md

@@ -4,4 +4,92 @@
 
 Please see "[Supported architectures and operating systems for self-hosted runners](https://docs.github.com/en/actions/reference/runners/self-hosted-runners#windows)."
 
-## [More .NET Core Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/windows-prerequisites?tabs=netcore30)
+## Quick Setup
+
+1. **Download** the latest runner from [releases](https://github.com/actions/runner/releases)
+2. **Extract** the downloaded archive to your desired directory
+3. **Run** `config.cmd` as Administrator to configure the runner
+4. **Install** as a service (optional): `svc.sh install` and `svc.sh start`
+
+## System Requirements
+
+### .NET Runtime
+- .NET 6.0 runtime (automatically installed with the runner)
+- Windows PowerShell 5.1 or PowerShell Core 6.0+
+
+### Windows Features
+Windows runners require the following components:
+
+```powershell
+# Enable required Windows features (run as Administrator)
+Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
+```
+
+### Visual Studio Build Tools (For builds requiring compilation)
+For repositories that need to compile code, install:
+
+- **Visual Studio 2017 or newer** [Install here](https://visualstudio.microsoft.com)
+- **Visual Studio 2022 17.3 Preview or later** (for ARM64) [Install here](https://docs.microsoft.com/en-us/visualstudio/releases/2022/release-notes-preview)
+
+### Git for Windows
+- **Git for Windows** [Install here](https://git-scm.com/downloads) (required for repository operations)
+
+## Common Setup Steps
+
+### 1. Create Runner Directory
+```cmd
+mkdir C:\actions-runner
+cd C:\actions-runner
+```
+
+### 2. Download and Extract
+```powershell
+# Download latest release
+Invoke-WebRequest -Uri "https://github.com/actions/runner/releases/download/v2.xyz.z/actions-runner-win-x64-2.xyz.z.zip" -OutFile "actions-runner.zip"
+# Extract
+Expand-Archive -Path "actions-runner.zip" -DestinationPath "."
+```
+
+### 3. Configure
+```cmd
+.\config.cmd --url https://github.com/YOUR_ORG/YOUR_REPO --token YOUR_TOKEN
+```
+
+### 4. Run as Service
+```cmd
+# Install service
+.\svc.sh install
+# Start service  
+.\svc.sh start
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**PowerShell Execution Policy:**
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+```
+
+**Windows Defender/Antivirus:**
+- Add runner directory to antivirus exclusions
+- Exclude `Runner.Listener.exe` and `Runner.Worker.exe`
+
+**Firewall Issues:**
+```powershell
+# Allow runner through Windows Firewall
+New-NetFirewallRule -DisplayName "GitHub Actions Runner" -Direction Inbound -Protocol TCP -LocalPort 443 -Action Allow
+```
+
+**Permission Issues:**
+- Run `config.cmd` as Administrator
+- Ensure the runner user has "Log on as a service" rights
+
+### Getting Help
+
+- Check our [troubleshooting guide](../checks/README.md)
+- Review [common issues](../checks/actions.md)
+- Search [GitHub Community Discussions](https://github.com/orgs/community/discussions/categories/actions)
+
+## [More .NET Prerequisites Information](https://docs.microsoft.com/en-us/dotnet/core/windows-prerequisites?tabs=netcore30)

releaseNote.md

@@ -1,13 +1,20 @@
 ## What's Changed
-* Try add orchestrationid into user-agent using token claim. by @TingluoHuang in https://github.com/actions/runner/pull/3945
-* Fix null reference exception in user agent handling by @salmanmkc in https://github.com/actions/runner/pull/3946
-* Runner Support for executing Node24 Actions by @salmanmkc in https://github.com/actions/runner/pull/3940
-* Update dotnet sdk to latest version @8.0.412 by @github-actions[bot] in https://github.com/actions/runner/pull/3941
+* Update Docker to v28.3.2 and Buildx to v0.26.1 by @github-actions[bot] in https://github.com/actions/runner/pull/3953
+* Fix if statement structure in update script and variable reference by @salmanmkc in https://github.com/actions/runner/pull/3956
+* Add V2 flow for runner deletion by @Samirat in https://github.com/actions/runner/pull/3954
+* Node 20 -> Node 24 migration feature flagging, opt-in and opt-out environment variables by @salmanmkc in https://github.com/actions/runner/pull/3948
+* Update Node20 and Node24 to latest by @djs-intel in https://github.com/actions/runner/pull/3972
+* Redirect supported OS doc section to current public Docs location by @corycalahan in https://github.com/actions/runner/pull/3979
+* Bump Microsoft.NET.Test.Sdk from 17.13.0 to 17.14.1 by @dependabot[bot] in https://github.com/actions/runner/pull/3975
+* Bump Azure.Storage.Blobs from 12.24.0 to 12.25.0 by @dependabot[bot] in https://github.com/actions/runner/pull/3974
+* Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in https://github.com/actions/runner/pull/3973
+* Bump actions/checkout from 4 to 5 by @dependabot[bot] in https://github.com/actions/runner/pull/3982
 
 ## New Contributors
-* @salmanmkc made their first contribution in https://github.com/actions/runner/pull/3946
+* @Samirat made their first contribution in https://github.com/actions/runner/pull/3954
+* @djs-intel made their first contribution in https://github.com/actions/runner/pull/3972
 
-**Full Changelog**: https://github.com/actions/runner/compare/v2.326.0...v2.327.0
+**Full Changelog**: https://github.com/actions/runner/compare/v2.327.1...v2.328.0
 
 _Note: Actions Runner follows a progressive release policy, so the latest release might not be available to your enterprise, organization, or repository yet.
 To confirm which version of the Actions Runner you should expect, please view the download instructions for your enterprise, organization, or repository.

src/Sdk/Sdk.csproj

@@ -26,7 +26,7 @@
         <PackageReference Include="System.Net.Http" Version="4.3.4" />
         <PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
         <PackageReference Include="System.Private.Uri" Version="4.3.2" />
-        <PackageReference Include="System.Formats.Asn1" Version="8.0.2" />
+        <PackageReference Include="System.Formats.Asn1" Version="8.0.1" />
     </ItemGroup>
 
     <ItemGroup>

src/runnerversion

@@ -1 +1 @@
-2.327.0
+2.328.0