wails/docs
Lea Anthony b4b0b90fff
fix(v3/docs): correct invalid runtime sub-path imports (#4989)
* fix(v3/docs): correct invalid runtime sub-path imports in documentation

The @wailsio/runtime package only exports "." and "./plugins/*" in its
package.json exports field. Documentation examples incorrectly used
sub-path imports like @wailsio/runtime/dialogs, /events, /window, etc.
which don't resolve at runtime. Updated all examples to use the correct
namespace import pattern (e.g., import { Dialogs } from '@wailsio/runtime').

Fixes wailsapp/wails#0000

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(v3/docs): correct invalid direct imports across remaining doc files

Fix imports that reference non-existent direct exports from
@wailsio/runtime. The package exports namespace objects (Events,
Window, Clipboard, etc.), not individual functions. Updated all
docs to use the correct namespace pattern:

- Events: On/Once/Off/OffAll/Emit → Events.On/Events.Emit/etc.
- Window: WindowMinimise/WindowClose → Window.Minimise/Window.Close
- Dialogs: OnEvent/Emit → Events.On/Events.Emit
- System: invoke → System.invoke
- Removed non-existent Platform import

Files: events.mdx, frameless.mdx, system.mdx, custom.mdx,
v2-to-v3.mdx, window.mdx, architecture.mdx, bridge.mdx,
events-reference.mdx, binding-system.mdx

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: update UNRELEASED_CHANGELOG.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-28 16:08:41 +11:00
..
.vscode [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
public Merge iOS support from v3-alpha-feature/ios-support 2025-12-10 18:34:21 +11:00
src fix(v3/docs): correct invalid runtime sub-path imports (#4989) 2026-02-28 16:08:41 +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: document automatic enum generation in binding generator (#4973) 2026-02-08 21:45:23 +11:00
CNAME Setup starlight workflow 2024-12-08 12:28:50 +11:00
package-lock.json fix(docs): update starlight-blog to v0.25.1 to fix build error 2025-11-24 21:54:59 +11:00
package.json fix(docs): update starlight-blog to v0.25.1 to fix build error 2025-11-24 21:54:59 +11:00
README.md docs: Comprehensive documentation redesign and v3-alpha updates 2025-11-23 20:57:25 +11:00
Taskfile.yml feat(v3): add cross-platform build system and signing support 2025-12-06 13:53:37 +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.