mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-14 14:45:49 +01:00
c84506a8a8
This commit represents a complete redesign of the Wails v3 documentation structure and includes all recent v3-alpha updates. ## Major Changes ### Documentation Restructure - Migrated from /learn to organized /features, /guides, /reference structure - Created new Quick Start section with installation and first app guides - Added comprehensive Concepts section explaining architecture and lifecycle - Reorganized Contributing section with detailed guides for different contribution types - Added complete API Reference with separate pages for each major component ### New Documentation - Custom URL Protocols guide with NSIS automatic registration - Windows Packaging guide with NSIS, MSI, and MSIX options - Typed Events system with TypeScript binding generation - Complete menu documentation (Application, Context, System Tray) - Comprehensive dialog documentation (File, Message, Custom) - Window management guides (Basics, Events, Frameless, Multiple Windows) - Bindings documentation (Services, Methods, Models, Best Practices) - New tutorials: Todo app and Notes app (vanilla JS) ### v3-alpha API Updates - Typed Events: RegisterEvent[T] with strict mode and binding generation - Custom Protocols: NSIS macros for automatic Windows protocol registration - System Tray: Windows Show/Hide now fully functional with tooltip limits - Window Hidden: Fixed white flash on Windows when creating hidden windows - Notifications: Corrected import path to pkg/services/notifications - Frontend Runtime: Events.Emit now returns Promise<boolean> for cancellation ### Documentation Improvements - Updated all code examples to use @wailsio/runtime imports - Added platform-specific event tables and examples - Created comprehensive event reference with use cases - Added security best practices and validation patterns - Improved code examples with real-world use cases - Added troubleshooting sections and common patterns ### Files - Created: 60+ new documentation pages - Deleted: Old /learn structure (13 files) - Modified: 15 existing files for v3-alpha compatibility - Added: Tutorial assets and showcase images
38 lines
998 B
YAML
38 lines
998 B
YAML
# https://taskfile.dev
|
|
|
|
version: '3'
|
|
|
|
vars:
|
|
# Change this to switch package managers: bun, npm, pnpm, yarn
|
|
PKG_MANAGER: bun
|
|
|
|
tasks:
|
|
|
|
setup:
|
|
summary: Setup the project (including D2 diagram tool)
|
|
preconditions:
|
|
- sh: '{{.PKG_MANAGER}} --version'
|
|
msg: "Looks like {{.PKG_MANAGER}} isn't installed."
|
|
- sh: 'go version'
|
|
msg: "Go is not installed. Install from https://go.dev/dl/"
|
|
cmds:
|
|
- '{{.PKG_MANAGER}} install'
|
|
- go install oss.terrastruct.com/d2@latest
|
|
- echo "✓ Setup complete. D2 installed to $(go env GOPATH)/bin/d2"
|
|
|
|
dev:
|
|
summary: Run the dev server
|
|
preconditions:
|
|
- sh: '{{.PKG_MANAGER}} --version'
|
|
msg: "Looks like {{.PKG_MANAGER}} isn't installed."
|
|
cmds:
|
|
- '{{.PKG_MANAGER}} run dev'
|
|
|
|
build:
|
|
summary: Build the docs
|
|
preconditions:
|
|
- sh: '{{.PKG_MANAGER}} --version'
|
|
msg: "Looks like {{.PKG_MANAGER}} isn't installed."
|
|
cmds:
|
|
- '{{.PKG_MANAGER}} run build'
|
|
|