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
2.4 KiB
Wails v3 Documentation
World-class documentation for Wails v3, redesigned following Netflix documentation principles.
📚 Documentation Redesign (2025-10-01)
This documentation has been completely redesigned to follow the Netflix approach to developer documentation:
- Problem-first framing - Start with why, not what
- Progressive disclosure - Multiple entry points for different skill levels
- Real production examples - No toy code
- Story-Code-Context pattern - Why → How → When
- Scannable content - Clear structure, visual aids
Status: Foundation complete (~20%), ready for content migration
See IMPLEMENTATION_SUMMARY.md for full details.
🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
Starlight looks for .md or .mdx files in the src/content/docs/ directory.
Each file is exposed as a route based on its file name.
Images can be added to src/assets/ and embedded in Markdown with a relative
link.
Static assets, like favicons, can be placed in the public/ directory.
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.