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 |
||
|---|---|---|
| .. | ||
| .vscode | ||
| blog | ||
| docs | ||
| i18n | ||
| src | ||
| static | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| babel.config.js | ||
| crowdin.yml | ||
| docusaurus.config.js | ||
| package.json | ||
| pnpm-lock.yaml | ||
| prettier.config.js | ||
| README.md | ||
| sidebars.js | ||
| Taskfile.yml | ||
| versions.json | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ npm
Local Development
$ npm run start
Other languages:
npm run start -- --locale <language>
language - The language code configured in the i18n field in the docusaurus.config.js file.
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Translate
After the English source file is updated, run the following command to submit the source file to Crowdin:
npm run crowdin push -- -b <branch>
branch - Branch name in crowdin project
Run the following command to pull the translated files in crowdin to the local:
npm run crowdin pull -- -b <branch> -l <languageCode>
languageCode - Note that this refers to the language code in the crowdin project.
The recommended practice is to update the English source file locally, then translate the file in crowdin, and finally pull the translated file to the local.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.