Skip to content

docs: audit and fix hallucinated v3 documentation - #4974

Closed
leaanthony wants to merge 373 commits into
v3-alphafrom
docs/audit-v3-documentation
Closed

leaanthony wants to merge 373 commits into
v3-alphafrom
docs/audit-v3-documentation

Conversation

@leaanthony

@leaanthony leaanthony commented Feb 8, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Comprehensive 3-pass audit of all v3 documentation against source code on origin/v3-alpha
  • Fixed hundreds of hallucinated API patterns, fabricated CLI flags, wrong method signatures, and incorrect struct fields across 140+ documentation files
  • Each pass used increasingly deep verification: pattern matching → source-code-first specialists → field-by-field deep verification with 7 specialist agents

Key fixes

Fabricated APIs removed:

  • OnStartup/OnBeforeClose/OnShutdown app hooks → ServiceStartup interface, ShouldQuit, RegisterHook
  • Window convenience methods (OnClose, OnFocus, OnBlur) → OnWindowEvent(events.Common.*, ...)
  • Package-level dialog functions (application.SaveFileDialog()) → Manager API (app.Dialog.SaveFile())
  • Non-existent JS functions (OnEvent, Emit) → Events.On, Events.Emit from @wailsio/runtime

Wrong CLI flags fixed:

  • Removed fabricated -platform, -o, -ldflags, -icon, -windowsconsole, -package, -skip-package flags
  • Documented actual Taskfile-based build system with GOOS/GOARCH for cross-compilation

Wrong types/fields corrected:

  • MacOptions → MacWindow, WindowsOptions → WindowsWindow, LinuxOptions → LinuxWindow
  • Resizable → DisableResize, WindowState → StartState
  • screen.Width → screen.Size.Width, screen.Height → screen.Size.Height
  • application.NewDefaultLogger() → application.DefaultLogger(slog.LevelDebug)
  • wails.ButtonHidden → application.ButtonHidden

Missing documentation added:

  • 20+ window methods, 30+ platform option fields, complete Application Options table
  • Missing CLI commands (tool lipo, tool sign, setup signing, doctor-ng, etc.)
  • ServiceName interface, ServiceOptions fields, dialog methods

Test plan

  • Verify docs build successfully with npm run build in docs/
  • Spot-check key pages against v3 source code
  • Verify no broken internal links

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive developer guide covering Wails v3 architecture, CLI, runtime, and build system.
    • Added extensive feature documentation for bindings, dialogs, menus, keyboard shortcuts, clipboard, browser integration, and environment management.
    • Added architectural concept guides including bridge, build system, and application lifecycle.
    • Added community showcase with 30+ projects built with Wails and community templates.
    • Added contributing guidelines for developers.
    • Added changelog and release notes for Wails versions.

leaanthony and others added 30 commits February 28, 2025 07:32
* docs: update Svelte recommendation

* Update routing.mdx

* Update changelog.mdx

* Updated changelog

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Fix Windows 11 identification in `wails doctor`
- Replace SW_RESTORE with SW_SHOW flag
- Resolves #4109
(cherry picked from commit fe6635c)
github-actions Bot and others added 23 commits January 10, 2026 20:01
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
…4806)

Disable suppressesIncrementalRendering on macOS 26+ (Tahoe) to prevent
WebView crashes when the frontend performs frequent UI updates.

Fixes #4592

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
Updated sponsorship section with JetBrains logo.
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
* fix(v2): Replace ioutl.Discard with io.Discard

* docs: Update website changelog

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
* Fix up templates to correct 1.23.0

* add changelog

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
* Update code block range in howdoesitwork.mdx

* docs: add changelog entry for PR #4884

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

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* fix(v2/linux): fix crash on panic in JS-bound Go methods

WebKit2GTK installs signal handlers after gtk_main() starts, overriding
our SA_ONSTACK fix. This causes Go panics (e.g., nil pointer dereference)
in JS-bound methods to crash with 'non-Go code set up signal handler
without SA_ONSTACK flag'.

Fix by deferring signal handler installation via g_idle_add() to run
after GTK main loop starts, ensuring we fix handlers AFTER WebKit
has installed its own.

Fixes #3965

* docs: add changelog entry for Linux signal handler fix

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

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* fix: add missing EventsOffAll export to runtime templates

The EventsOffAll function was implemented in the internal runtime
(desktop/events.js) and exported in the wrapper runtime files, but was
missing from the public runtime templates that are generated in user
projects. This caused a type mismatch where EventsOffAll was declared
in the TypeScript definition but the implementation was missing.

This commit adds the EventsOffAll export and type declaration to all
frontend framework templates:
- Common templates (generate/assets/common)
- React / React-TS
- Vue / Vue-TS
- Svelte / Svelte-TS
- Preact / Preact-TS
- Lit / Lit-TS
- Vanilla / Vanilla-TS

Fixes #4703

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* docs: add EventsOffAll to runtime events documentation

Added EventsOffAll function documentation to both English and Chinese
versions of the runtime events reference.

The function was already implemented in Go (pkg/runtime/events.go) and
JavaScript (internal/frontend/runtime/desktop/events.js), but was missing
from the public documentation.

Related to #4703

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* chore: add EventsOffAll fix to changelog

Added entry for the EventsOffAll fix to the Unreleased section
of the changelog.

Related to #4703

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* docs: translate EventsOffAll description to Chinese

Improved consistency in Chinese documentation by translating the
EventsOffAll description from English to Chinese, matching the
style of other event method descriptions.

Related to #4703

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

---------

Co-authored-by: cc <Zhuanz@MacBook-Pro.local>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
- Fix Dockerfile path (was pointing to non-existent setupwizard/docker)
- Add multi-platform build (linux/amd64 + linux/arm64)
- Add QEMU for ARM64 cross-compilation
- Add automatic trigger on Dockerfile.cross changes to v3-alpha
- Update SDK version default to 14.5

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add test-cross-compile job that tests CGO builds for all 6 platform/arch combos
- Add test-non-cgo job for pure Go cross-compilation verification
- Add test-summary job with GitHub Actions summary output
- Add skip_tests input for manual workflow dispatch
- Verify Linux binaries link to required GTK/WebKit libraries
- Verify binary format matches expected architecture

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
Co-authored-by: leaanthony <1943904+leaanthony@users.noreply.github.com>
…4921)

* feat(v2): add runtime.ResetSignalHandlers() for Linux panic recovery

Add a new runtime function that allows users to reset signal handlers
before code that might panic from nil pointer dereferences.

On Linux, WebKit installs signal handlers without the SA_ONSTACK flag,
which prevents Go from properly recovering from panics caused by
SIGSEGV and other signals. This function adds SA_ONSTACK to the
relevant signal handlers (SIGSEGV, SIGBUS, SIGFPE, SIGABRT).

Usage:
```go
go func() {
    defer func() {
        if err := recover(); err != nil {
            log.Printf("Recovered: %v", err)
        }
    }()
    runtime.ResetSignalHandlers()
    // Code that might panic...
}()
```

The function is a no-op on macOS and Windows.

Fixes #3965

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

* test(v2): add panic-recovery-test example

Add an example that demonstrates the Linux signal handler issue (#3965)
and verifies the fix using runtime.ResetSignalHandlers().

The example includes:
- A Greet function that triggers a nil pointer dereference after a delay
- Auto-call from frontend after 5 seconds
- README with reproduction steps

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

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* fix(v2): prevent wails init in non-empty directory with -d flag

When using -d to specify a target directory, wails init now checks if
the directory is non-empty and errors if so. This prevents accidental
data loss (e.g., overwriting .git directories).

Fixes #4940

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

* test(v2): add tests for init non-empty directory check

Add tests to verify:
- Install fails when target directory is non-empty
- Install succeeds when target directory is empty

Also update changelog with the fix.

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

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Audit all v3 documentation pages against actual source code on v3-alpha
branch. Fix incorrect API patterns that were hallucinated during docs
generation.

Key fixes across 38 files:
- app.NewWebviewWindow() → app.Window.New()
- app.NewWebviewWindowWithOptions() → app.Window.NewWithOptions()
- app.NewSystemTray() → app.SystemTray.New()
- app.EmitEvent() → app.Event.Emit()
- app.OnEvent() → app.Event.On()
- app.CurrentWindow() → app.Window.Current()
- app.GetWindowByName() → app.Window.GetByName()
- app.OnWindowCreation() → app.Window.OnCreate()
- app.NewMenu() → application.NewMenu()
- *application.Application → *application.App
- *application.WailsEvent → *application.CustomEvent
- window.SetFocus() → window.Focus()
- window.SetFullscreen() → window.ToggleFullscreen()
- SetWindowOffset() → WindowOffset()
- SetWindowDebounce() → WindowDebounce()
- KeyBinding callback: func(*WebviewWindow) → func(Window)
- SetBackgroundColour(r,g,b,a) → SetBackgroundColour(RGBA{})
- app.Events.On() → app.Event.On()/app.Event.OnApplicationEvent()

Sections audited: reference/, features/, concepts/, guides/,
tutorials/, migration/, contributing/, getting-started/, quick-start/,
faq, whats-new, DEVELOPER_GUIDE

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Deep second-pass audit using 6 specialist agents, each reading v3 source
code first then verifying every code example in their domain.

Window specialist (6 files):
- Remove fabricated convenience methods (OnClose, OnFocus, OnBlur, etc.)
- Fix platform struct names: MacOptions→MacWindow, WindowsOptions→WindowsWindow
- Fix field names: Resizable→DisableResize, WindowState→StartState
- Remove non-existent fields: Parent, Assets, OnClose on options
- Fix SetBackgroundColour to take RGBA struct
- Full rewrite of windows/events.mdx to use OnWindowEvent pattern

Event specialist (3 files):
- Fix wrong constants: WindowBlur→WindowLostFocus, WindowClosed→WindowClosing
- Fix wrong method: OpenedFile()→Filename()
- Fix JS import patterns and Emit namespace
- Split mixed Go/JS code blocks

Menu specialist (3 files):
- Fix context menu CSS property name
- Fix menu guide patterns

Dialog specialist (5 files):
- All correct, no fixes needed

Bindings specialist (5 files):
- Fix generated JS/TS binding examples to use $Call.ByID()
- Fix sync.Mutex→sync.RWMutex compile error
- Fix //wails:internal on unexported methods

General specialist (6 files):
- Fix remaining *application.Application refs
- Fix old dialog patterns in FAQ and migration guide
- Fix changelog method names: Register→Add, Unregister→Remove
- Fix Screen.GetAll return type, Env.GetAll→Env.Info

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…gs, and examples

Deep audit of 23 documentation files against v3 source code:

- reference/window.mdx: Added 20+ missing methods (ToggleFullscreen, ToggleMaximise,
  ForceReload, Width/Height, Bounds, PhysicalBounds, SnapAssist, ToggleFrameless,
  ShowMenuBar/HideMenuBar/ToggleMenuBar), fixed EmitEvent return docs
- reference/dialogs.mdx: Added missing dialog methods (ResolvesAliases,
  AllowsOtherFileTypes, HideExtension, SetMessage, SetButtonText, AddButtons,
  OpenFileWithOptions, SaveFileWithOptions, full SaveFileDialogStruct methods)
- reference/menu.mdx: Added missing MenuItem methods and role constants
- reference/events.mdx: Fixed event constant names and struct fields
- guides/cli.mdx: Added missing CLI flags (-s, -mod, -tags, -noevents), fixed
  -clean default to true, added missing commands (tool lipo, tool capabilities,
  tool sign, setup signing, setup entitlements, doctor-ng, generate template)
- guides/building.mdx: Fixed fabricated build flags, corrected Taskfile structure
- concepts/lifecycle.mdx: Replaced hallucinated OnStartup/OnBeforeClose hooks with
  actual ServiceStartup interface, ShouldQuit option, RegisterHook pattern
- concepts/build-system.mdx: Fixed Vite port (5173->9245), corrected Taskfile.yml
  to match actual project structure with platform-specific includes
- features/screens/info.mdx: Fixed app.Screens->app.Screen, replaced fabricated
  Screen struct with real one (Bounds, PhysicalBounds, WorkArea, Rotation fields),
  removed non-existent GetCurrent/GetByID methods
- features/windows/options.mdx: Added missing platform option fields
- tutorials/03-notes-vanilla.mdx: Fixed package-level dialog functions to manager
  API, fixed service registration pattern with app reference passing

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Additional fixes from deep-audit agents that completed after initial staging:

- reference/application.mdx: Added complete Options struct table (30+ fields),
  AssetOptions, platform options (MacOptions, WindowsOptions, LinuxOptions),
  missing methods (SetIcon, GetPID, Capabilities)
- features/events/system.mdx: Fixed JS event callbacks - handler receives event
  object, data is at event.data not passed directly
- features/bindings/services.mdx: Added ServiceName interface, ServiceOptions
  table with Name/Route/MarshalError fields
- reference/dialogs.mdx: Removed non-existent SetTitle() from SaveFileDialogStruct,
  documented SaveFileWithOptions as correct approach
- guides/events-reference.mdx: Fixed theme change pattern - system events don't
  carry theme data, show proper Go->JS forwarding
- guides/build/windows.mdx: Removed fabricated -platform flag, use GOARCH instead
- migration/v2-to-v3.mdx: Fixed OnClick callbacks to take *application.Context
- getting-started/installation.mdx: wails doctor -> wails3 doctor
- concepts/lifecycle.mdx: Fixed leftover OnStartup reference

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- concepts/bridge.mdx: Fixed logger to use slog (not fabricated
  application.NewDefaultLogger/logger.DEBUG)
- concepts/manager-api.mdx: Fixed SetDefaultFilename -> SetFilename
- faq.mdx: Fixed build output dir, removed fabricated -platform flag,
  corrected binary size reduction advice

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 8, 2026 10:45
@github-actions github-actions Bot added the Documentation Improvements or additions to documentation label Feb 8, 2026
@coderabbitai

coderabbitai Bot commented Feb 8, 2026 •

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Comprehensive documentation expansion adding 50+ markdown and MDX files covering developer guides, release notes, architecture documentation, contributing guidelines, community pages, and feature API references for Wails v3, totaling 10,000+ lines of content.

Changes

Cohort / File(s) Summary
Developer Guides
docs/src/content/docs/DEVELOPER_GUIDE.md
New extensive v3 developer guide with repository map, CLI entry points, build system, runtime flow, asset generation, message bridging, windowing, services, bindings, configuration, and debugging guidance.
Release Notes & Blog Posts
docs/src/content/docs/blog/2021-*.md, docs/src/content/docs/blog/2022-*.md, docs/src/content/docs/blog/2023-*.md, docs/src/content/docs/blog/2024-*.md
Multiple release announcement blog posts for Wails v2 beta, v2 releases, and v3 roadmap/alpha 10 updates with feature highlights and development notes.
Changelog
docs/src/content/docs/changelog.mdx
Comprehensive Keep a Changelog–style changelog documenting v3 alpha releases with Added, Changed, Fixed sections and platform-specific changes.
Community Pages
docs/src/content/docs/community/links.md, docs/src/content/docs/community/templates.md, docs/src/content/docs/community/showcase/*
Community hub pages including resources directory, community templates listing (40+ entries), showcase gallery index, template submission guide, and 30+ individual showcase entries for projects built with Wails.
Architecture & Concepts
docs/src/content/docs/concepts/architecture.mdx, docs/src/content/docs/concepts/bridge.mdx, docs/src/content/docs/concepts/build-system.mdx, docs/src/content/docs/concepts/lifecycle.mdx, docs/src/content/docs/concepts/manager-api.mdx
Foundational documentation explaining Wails internals including native WebView bridge, build process, application lifecycle, and manager-based API design.
Contributing & Standards
docs/src/content/docs/contributing.mdx, docs/src/content/docs/contributing/setup.mdx, docs/src/content/docs/contributing/standards.mdx, docs/src/content/docs/contributing/getting-started.mdx
Contributor guides covering repository setup, development environment, coding standards, commit practices, and step-by-step contribution workflows.
Technical Architecture
docs/src/content/docs/contributing/architecture.mdx, docs/src/content/docs/contributing/architecture/bindings.mdx, docs/src/content/docs/contributing/binding-system.mdx, docs/src/content/docs/contributing/asset-server.mdx, docs/src/content/docs/contributing/build-packaging.mdx, docs/src/content/docs/contributing/codebase-layout.mdx, docs/src/content/docs/contributing/runtime-internals.mdx, docs/src/content/docs/contributing/template-system.mdx, docs/src/content/docs/contributing/testing-ci.mdx, docs/src/content/docs/contributing/extending-wails.mdx, docs/src/content/docs/contributing/index.mdx
Deep-dive technical documentation for contributors covering architecture diagrams, binding system internals, asset serving, build pipelines, codebase navigation, runtime flows, testing strategies, and extension patterns.
Feature Bindings Documentation
docs/src/content/docs/features/bindings/methods.mdx, docs/src/content/docs/features/bindings/models.mdx, docs/src/content/docs/features/bindings/services.mdx, docs/src/content/docs/features/bindings/advanced.mdx, docs/src/content/docs/features/bindings/best-practices.mdx
Comprehensive binding system guides covering method bindings, data model generation, service architecture, advanced directives, optimization techniques, and design patterns.
Dialog & UI Features
docs/src/content/docs/features/dialogs/overview.mdx, docs/src/content/docs/features/dialogs/message.mdx, docs/src/content/docs/features/dialogs/file.mdx, docs/src/content/docs/features/dialogs/custom.mdx
Dialog system documentation including message dialogs, file selection, custom dialog implementation, and platform-specific behavior for macOS, Windows, and Linux.
Menu & Input Features
docs/src/content/docs/features/menus/application.mdx, docs/src/content/docs/features/menus/context.mdx, docs/src/content/docs/features/keyboard/shortcuts.mdx
Native menu and keyboard input documentation covering application menus, context menus, menu item types, global keyboard shortcuts, and platform-specific implementations.
System & Event Features
docs/src/content/docs/features/clipboard/basics.mdx, docs/src/content/docs/features/events/system.mdx, docs/src/content/docs/features/environment/info.mdx, docs/src/content/docs/features/browser/integration.mdx
APIs for system integration including clipboard operations, custom event system, environment detection/theming, and browser integration for opening URLs/files.
Miscellaneous Documentation
docs/src/content/docs/contributing/_category_.json, docs/src/content/docs/credits.mdx, docs/src/content/docs/faq.mdx
Configuration, credits page highlighting contributors/sponsors, and comprehensive FAQ addressing general, development, building, features, performance, and troubleshooting topics.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~70 minutes

Possibly related PRs

Suggested labels

Documentation, v3, size:XXL, lgtm

Suggested reviewers

  • ndianabasi
  • atterpac

Poem

🐰 Whiskers twitch with pure delight,
Pages overflow, words burn bright,
Ten thousand lines of guides so grand,
A roadmap through the Wails-built land,
From bridge to build, from docs to dreams,
The framework guides its dev-teams! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/audit-v3-documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@leaanthony
leaanthony changed the base branch from master to v3-alpha February 8, 2026 10:46
@leaanthony

Copy link
Copy Markdown
Member Author

Closing - branch was incorrectly based off master instead of docs-redesign. Will recreate with correct base.

@leaanthony leaanthony closed this Feb 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR performs a broad audit of the Wails v3 documentation, replacing hallucinated APIs/flags/types with verified v3-alpha behavior and adding missing reference material across feature and contributor sections.

Changes:

  • Added/rewrote feature docs for dialogs, clipboard, browser integration, keyboard shortcuts, and bindings.
  • Added a new “Technical Documentation” contributor section with architecture/build/binding-system/runtime internals material.
  • Expanded community & blog content pages (showcase entries, templates/community links, historical posts).

Reviewed changes

Copilot reviewed 107 out of 1928 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
docs/src/content/docs/features/keyboard/shortcuts.mdx Adds keyboard shortcut/keybinding documentation and examples.
docs/src/content/docs/features/dialogs/overview.mdx Adds dialogs feature overview and usage patterns.
docs/src/content/docs/features/dialogs/message.mdx Adds message dialog reference with examples and best practices.
docs/src/content/docs/features/clipboard/basics.mdx Adds clipboard API basics and integrations/examples.
docs/src/content/docs/features/browser/integration.mdx Adds Browser manager docs for opening URLs/files and common patterns.
docs/src/content/docs/features/bindings/advanced.mdx Adds advanced bindings directives and generation options.
docs/src/content/docs/faq.mdx Adds/updates v3-focused FAQ content.
docs/src/content/docs/credits.mdx Adds credits/sponsors/contributors page content.
docs/src/content/docs/contributing/testing-ci.mdx Adds technical guidance on tests, race detection, and CI.
docs/src/content/docs/contributing/template-system.mdx Documents template system internals and authoring workflow.
docs/src/content/docs/contributing/standards.mdx Adds coding standards for Go/JS/TS and contribution workflow.
docs/src/content/docs/contributing/setup.mdx Adds dev environment setup instructions for contributors.
docs/src/content/docs/contributing/runtime-internals.mdx Adds deep-dive runtime internals and message processing docs.
docs/src/content/docs/contributing/index.mdx Adds technical documentation landing page with architecture context.
docs/src/content/docs/contributing/getting-started.mdx Adds contributor getting-started guide with workflows.
docs/src/content/docs/contributing/extending-wails.mdx Adds guide for extending services/CLI/runtime/capabilities.
docs/src/content/docs/contributing/codebase-layout.mdx Adds repository layout and navigation map for v3.
docs/src/content/docs/contributing/build-packaging.mdx Adds build/packaging pipeline walkthrough and troubleshooting.
docs/src/content/docs/contributing/binding-system.mdx Adds binding system explanation (analysis → generation → runtime).
docs/src/content/docs/contributing/asset-server.mdx Adds asset server dev/prod mode documentation.
docs/src/content/docs/contributing/architecture/bindings.mdx Adds architecture-focused binding system component breakdown.
docs/src/content/docs/contributing/architecture.mdx Adds high-level architecture diagrams and layer responsibilities.
docs/src/content/docs/contributing/category.json Adds sidebar category metadata for technical documentation.
docs/src/content/docs/contributing.mdx Adds general contributing page and navigation cards.
docs/src/content/docs/concepts/manager-api.mdx Documents manager-based API organization and reference.
docs/src/content/docs/community/templates.md Adds/updates community templates listing page.
docs/src/content/docs/community/showcase/ytd.md Adds showcase entry for Ytd.
docs/src/content/docs/community/showcase/wombat.md Adds showcase entry for Wombat.
docs/src/content/docs/community/showcase/warmine.md Adds showcase entry for WarMine launcher.
docs/src/content/docs/community/showcase/wally.md Adds showcase entry for Wally.
docs/src/content/docs/community/showcase/wailsterm.md Adds showcase entry for WailsTerm.
docs/src/content/docs/community/showcase/tinyrdm.md Adds showcase entry for Tiny RDM.
docs/src/content/docs/community/showcase/surge.md Adds showcase entry for Surge.
docs/src/content/docs/community/showcase/snippetexpander.md Adds showcase entry for Snippet Expander.
docs/src/content/docs/community/showcase/scriptbar.md Adds showcase entry for ScriptBar.
docs/src/content/docs/community/showcase/riftshare.md Adds showcase entry for RiftShare.
docs/src/content/docs/community/showcase/restic-browser.md Adds showcase entry for Restic Browser.
docs/src/content/docs/community/showcase/resizem.md Adds showcase entry for Resizem.
docs/src/content/docs/community/showcase/portfall.md Adds showcase entry for Portfall.
docs/src/content/docs/community/showcase/optimus.md Adds showcase entry for Optimus.
docs/src/content/docs/community/showcase/october.md Adds showcase entry for October.
docs/src/content/docs/community/showcase/mollywallet.md Adds showcase entry for Molly Wallet.
docs/src/content/docs/community/showcase/modalfilemanager.md Adds showcase entry for Modal File Manager.
docs/src/content/docs/community/showcase/minesweeper-xp.md Adds showcase entry for Minesweeper XP.
docs/src/content/docs/community/showcase/minecraftupdater.md Adds showcase entry for Minecraft Updater.
docs/src/content/docs/community/showcase/mchat.md Adds showcase entry for Mchat.
docs/src/content/docs/community/showcase/index.mdx Updates showcase index grid and contribution steps.
docs/src/content/docs/community/showcase/hiposter.md Adds showcase entry for hiposter.
docs/src/content/docs/community/showcase/filehound.md Adds showcase entry for FileHound Export Utility.
docs/src/content/docs/community/showcase/espstudio.md Adds showcase entry for ESP Studio.
docs/src/content/docs/community/showcase/encrypteasy.md Adds showcase entry for EncryptEasy.
docs/src/content/docs/community/showcase/emailit.md Adds showcase entry for EmailIt.
docs/src/content/docs/community/showcase/clave.md Adds showcase entry for Clave.
docs/src/content/docs/community/showcase/cfntracker.md Adds showcase entry for CFN Tracker.
docs/src/content/docs/community/showcase/bulletinboard.md Adds showcase entry for BulletinBoard.
docs/src/content/docs/community/showcase/_template.md Adds template for new showcase entries.
docs/src/content/docs/community/links.md Adds community links page.
docs/src/content/docs/blog/2024-12-03-alpha10-and-new-release-strategy.md Adds v3 alpha release strategy post.
docs/src/content/docs/blog/2023-01-17-v3-roadmap.md Adds v3 roadmap blog post.
docs/src/content/docs/blog/2022-09-22-v2-release-notes.md Adds v2 release notes blog post.
docs/src/content/docs/blog/2022-02-22-v2-beta3-release-notes.md Adds v2 beta for Linux blog post.
docs/src/content/docs/blog/2021-11-08-v2-beta2-release-notes.md Adds v2 beta for macOS blog post.
docs/src/content/docs/blog/2021-09-27-v2-beta1-release-notes.md Adds v2 beta for Windows blog post.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +168 to +169
func isValidURL(url string) bool {
parsed, err := url.Parse(url)

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name url shadows the net/url package, so url.Parse(url) won’t compile (attempts to call Parse on a string). Rename the parameter (e.g. rawURL) and ensure net/url is imported, then parse using the package identifier.

Suggested change
func isValidURL(url string) bool {
parsed, err := url.Parse(url)
func isValidURL(rawURL string) bool {
parsed, err := url.Parse(rawURL)

Copilot uses AI. Check for mistakes.

## Accessing the Key Binding Manager

The key binding manager is accessed through the `KeyBindings` property on your application instance:

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prose references a KeyBindings property, but the example uses app.KeyBinding. Update the text to match the actual API name to avoid confusing readers.

Suggested change
The key binding manager is accessed through the `KeyBindings` property on your application instance:
The key binding manager is accessed through the `KeyBinding` property on your application instance:

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,494 @@
---
title: dialogs Overview

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct capitalization in the page title to keep navigation/search results consistent.

Suggested change
title: dialogs Overview
title: Dialogs Overview

Copilot uses AI. Check for mistakes.

**That's it!** Native dialogs with minimal code.

## dialog Types

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The headings use inconsistent capitalization (“dialog” vs “Dialog(s)”) compared to other docs pages. Standardizing heading case improves sidebar consistency and searchability.

Copilot uses AI. Check for mistakes.
}
```

## dialog Options

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The headings use inconsistent capitalization (“dialog” vs “Dialog(s)”) compared to other docs pages. Standardizing heading case improves sidebar consistency and searchability.

Copilot uses AI. Check for mistakes.
Comment on lines +11 to +16
| Layer | Goal | Tooling |
|-------|------|---------|
| Unit tests | Fast feedback for isolated functions | `go test ./...` |
| Integration / Example tests | Validate whole features across packages | Example apps + headless assertions |
| Race detection | Catch data races in the runtime & bridge | `go test -race`, `wails3 dev -race` |
| CI matrix | Cross-OS confidence on every PR | GitHub Actions |

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tables use || ... which is not standard Markdown table syntax and may render incorrectly in many Markdown/MDX pipelines. Use standard |-delimited tables to ensure consistent rendering.

Copilot uses AI. Check for mistakes.
![Tiny RDM Screenshot](../../../../assets/showcase-images/tiny-rdm2.webp)

The [Tiny RDM](https://redis.tinycraft.cc/) application is an open-source,
modern lightweight Redis GUI. It has a beautful UI, intuitive Redis database

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of “beautful” to “beautiful”.

Suggested change
modern lightweight Redis GUI. It has a beautful UI, intuitive Redis database
modern lightweight Redis GUI. It has a beautiful UI, intuitive Redis database

Copilot uses AI. Check for mistakes.
defined in EmailIt program and shows the output. Scripts from xBar or TextBar
can be used, but currently on the TextBar scripts work well. It also displays
the output of scripts on your system. ScriptBar doesn't put them in the menubar,
but has them all in a convient window for easy viewing. You can have multiple

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of “convient” to “convenient”.

Suggested change
but has them all in a convient window for easy viewing. You can have multiple
but has them all in a convenient window for easy viewing. You can have multiple

Copilot uses AI. Check for mistakes.
Comment on lines +8 to +13
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typos/spacing: “versital” → “versatile”, “latter” → “later”, and “T here” → “There”.

Suggested change
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an
versatile message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can later be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. There is also an

Copilot uses AI. Check for mistakes.
Comment on lines +8 to +13
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an

Copilot AI Feb 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typos/spacing: “versital” → “versatile”, “latter” → “later”, and “T here” → “There”.

Suggested change
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an
versatile message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can later be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. There is also an

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.