README.md

WinBorg Documentation

This folder contains developer-facing documentation for WinBorg.

Public repository note

This repository is public. Please keep documentation safe to publish:

• Do not include real customer/user data, real hostnames, IPs, emails, or internal URLs.
• Do not include secrets (tokens, passwords, private keys). Use placeholders like user@host.
• If you need to share sensitive operational details, keep them in a private/internal location instead of docs/.

Start here

• Architecture
• IPC contract (Renderer ↔ Main)
• Testing
• Test strategy (risk-based)

Supporting checklists

• Test plan
• Functional test matrix
• Compatibility matrix
• Operations
• Audit notes
• Security checklist
• UX checklist

Release & operations

• Release checklist

Notes

• The app is an Electron desktop application.
• Most “backend” behavior lives in the Electron main process (electron-main.js) and small, unit-testable modules under main/.
• Borg runs inside WSL (Linux), but the UI is native Windows.