docs: fix custom protocol association documentation - #4825
Conversation
The documentation was incorrectly referencing `wails.json` with JSON format
when the actual configuration file is `build/config.yml` using YAML format.
Changes:
- Update config file reference from `wails.json` to `build/config.yml`
- Change format from JSON to YAML in code examples
- Fix structure: `protocols` is at root level, not nested under `info`
- Correct template variable references from `{{.Info.Protocols}}` to `{{.Protocols}}`
- Update Info.plist example to show actual generated format (`wails.com.scheme`)
- Add note about running `wails3 task common:update:build-assets` after changes
- Clean up redundant file path references in platform-specific sections
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. WalkthroughDeleted the legacy custom-protocol-association guide, consolidated and expanded custom-protocol documentation (including Windows MSIX App URI Handler and macOS Universal Links), and added MSIX manifest template support for declared protocols. No runtime API signatures were changed. Changes
Sequence Diagram(s)mermaid Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
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. Comment |
Deploying wails with
|
| Latest commit: |
a38e2c7
|
| Status: | ⚡️ Build in progress... |
|
There are two custom protocol documentation:
The first one is not listed in the sidebar, but the second one is. Should the second one be removed and the first one added to the sidebar so it is easier to find? |
- Remove duplicate custom-protocol-association.mdx - Add Universal Links section to macOS tab - Add Web-to-App Linking section to Windows tab - Keep the more comprehensive distribution/custom-protocols.mdx Addresses review comment about duplicate documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add uap3 namespace and protocol extension to MSIX template - Protocols defined in build/config.yml are now automatically registered when building MSIX packages - Update docs with MSIX section and clarify Web-to-App linking requires manual manifest configuration 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/src/content/docs/guides/distribution/custom-protocols.mdx (4)
162-162: Avoid Apple-specific terminology for Windows feature.The heading "Universal Links (Web-to-App Linking)" uses "Universal Links," which is Apple-specific branding. This could confuse readers since this section is about Windows. Consider changing to just "Web-to-App Linking" or "App URI Handlers" to match Microsoft's terminology.
🔎 Suggested heading change
-#### Universal Links (Web-to-App Linking) +#### Web-to-App Linking
169-175: Add context about XML namespace declaration.The XML example uses the
uap3:namespace prefix, but in a complete MSIX manifest this requires a correspondingxmlns:uap3declaration in the root<Package>element. Consider adding a brief note that this snippet must be added to the<Extensions>section of a properly configured MSIX manifest.💡 Example note to add
1. **Add App URI Handler in your MSIX manifest**: + Add this extension to the `<Extensions>` section of your manifest (ensure `xmlns:uap3` is declared in the root `<Package>` element): ```xml
177-177: Clarify windows-app-web-link file format.The documentation mentions hosting a
windows-app-web-linkfile but doesn't describe its format or provide an example. Consider adding a brief note about the JSON structure or linking to the relevant section in the Microsoft documentation.
221-250: Well-documented macOS Universal Links section with one recommended addition.The code-signing requirement is properly emphasized with the caution aside, and the XML examples are correct. The documentation link is current and accessible.
Add a brief note that the
apple-app-site-associationfile must be served over HTTPS with a valid SSL certificate. This is a key requirement that developers commonly overlook, especially when testing locally or with self-signed certificates.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/src/content/docs/guides/custom-protocol-association.mdxdocs/src/content/docs/guides/distribution/custom-protocols.mdxv3/UNRELEASED_CHANGELOG.md
💤 Files with no reviewable changes (1)
- docs/src/content/docs/guides/custom-protocol-association.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- v3/UNRELEASED_CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Analyze (go)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/src/content/docs/guides/distribution/custom-protocols.mdx (2)
8-8: LGTM!The
Asideimport is correctly added and used in the macOS Universal Links section below.
166-166: The Microsoft documentation link is accessible and current.
Good call out! Looks like the Universal links docs were added to an older document. Consolidated and added windows support. |
|
* docs: fix custom protocol association documentation
The documentation was incorrectly referencing `wails.json` with JSON format
when the actual configuration file is `build/config.yml` using YAML format.
Changes:
- Update config file reference from `wails.json` to `build/config.yml`
- Change format from JSON to YAML in code examples
- Fix structure: `protocols` is at root level, not nested under `info`
- Correct template variable references from `{{.Info.Protocols}}` to `{{.Protocols}}`
- Update Info.plist example to show actual generated format (`wails.com.scheme`)
- Add note about running `wails3 task common:update:build-assets` after changes
- Clean up redundant file path references in platform-specific sections
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: consolidate custom protocol docs and add Universal Links
- Remove duplicate custom-protocol-association.mdx
- Add Universal Links section to macOS tab
- Add Web-to-App Linking section to Windows tab
- Keep the more comprehensive distribution/custom-protocols.mdx
Addresses review comment about duplicate documentation.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* feat(windows): add custom protocol support to MSIX packaging
- Add uap3 namespace and protocol extension to MSIX template
- Protocols defined in build/config.yml are now automatically
registered when building MSIX packages
- Update docs with MSIX section and clarify Web-to-App linking
requires manual manifest configuration
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude <noreply@anthropic.com>
2 participants
Summary
The custom protocol association documentation was incorrect. It referenced
wails.jsonwith JSON format when the actual configuration file isbuild/config.ymlusing YAML format.Issues Fixed:
wails.jsontobuild/config.ymlprotocolsis at root level, not nested underinfo{{.Info.Protocols}}to{{.Protocols}}wails.com.scheme)wails3 task common:update:build-assetsafter modifying protocolsVerification:
The documentation now matches the actual implementation found in:
v3/internal/commands/build-assets.go- YAML config parsing withprotocolsat root levelv3/examples/custom-protocol-example/build/config.yml- Working example showing correct formatv3/internal/commands/updatable_build_assets/*/- Templates using{{.Protocols}}Test plan
v3/examples/custom-protocol-example/🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.