wails/docs
Lea Anthony e2e0f5c95e docs: fix lifecycle docs - use events not services for lifecycle hooks
ServiceStartup is for service resource initialization (DB, config),
NOT for application lifecycle hooks. Application lifecycle events
(events.Common.ApplicationStarted, ThemeChanged) are the correct
mechanism for reacting to lifecycle stages.

- architecture.mdx: replace misleading "Lifecycle hooks" section
- lifecycle.mdx: add Application Lifecycle Events section (new §3)
- lifecycle.mdx: rename "Service Startup" to "Service Initialisation"
- lifecycle.mdx: categorize reference table (events/services/options)
- lifecycle.mdx: update d2 diagram with ApplicationStarted stage
- lifecycle.mdx: update best practices to distinguish init vs lifecycle

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-09 19:27:10 +11:00
..
.vscode [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
public docs: Update landing page and fix tutorial links 2025-11-22 17:19:29 +11:00
src docs: fix lifecycle docs - use events not services for lifecycle hooks 2026-02-09 19:27:10 +11:00
.gitignore [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
.npmrc Docs: Add community page(s) (#3941) 2024-12-10 07:53:36 +11:00
astro.config.mjs docs: Streamline Contributing section and add comprehensive guides 2025-11-22 22:37:21 +11:00
build-output.txt docs: Complete documentation redesign with enhanced landing page 2025-10-04 22:15:35 +10:00
bun.lock docs: Complete documentation redesign with enhanced landing page 2025-10-04 22:15:35 +10:00
CNAME Setup starlight workflow 2024-12-08 12:28:50 +11:00
create-dirs.ps1 docs: Complete documentation redesign with enhanced landing page 2025-10-04 22:15:35 +10:00
package-lock.json Improve documentation clarity and reduce cognitive load 2025-11-15 08:42:09 +11:00
package.json docs: Complete documentation redesign with enhanced landing page 2025-10-04 22:15:35 +10:00
README.md docs: Complete documentation redesign with enhanced landing page 2025-10-04 22:15:35 +10:00
Taskfile.yml Improve documentation clarity and reduce cognitive load 2025-11-15 08:42:09 +11:00
tsconfig.json [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00

Wails v3 Documentation

Built with Starlight

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 Starlights docs, read the Astro documentation, or jump into the Astro Discord server.