chore(docs): update dependencies and improve documentation formatting #4699
Conversation
WalkthroughReplaced action pins in the GitHub Actions workflow; converted docs Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
github-actions
bot
added
the
Documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/astro.config.mjs (1)
9-9: Minor: Quote style inconsistency.The import statement changed from single quotes to double quotes. While functional, this is inconsistent with the rest of the file which uses double quotes for imports. The change actually makes it more consistent.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (6)
.github/workflows/v3-docs.yml(1 hunks)docs/astro.config.mjs(3 hunks)docs/package.json(1 hunks)docs/src/content/docs/contributing/architecture.mdx(4 hunks)docs/src/content/docs/contributing/index.mdx(1 hunks)docs/src/content/docs/guides/custom-protocol-association.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📚 Learning: 2024-12-03T07:49:16.593Z
Learnt from: stavros-k
Repo: wailsapp/wails PR: 3917
File: docs/src/assets/contributors.astro:0-0
Timestamp: 2024-12-03T07:49:16.593Z
Learning: The table in 'docs/src/assets/contributors.astro' is autogenerated by another bot, so manual changes to it would be overwritten and are unnecessary.
Applied to files:
docs/astro.config.mjs
📚 Learning: 2025-08-08T09:13:16.916Z
Learnt from: APshenkin
Repo: wailsapp/wails PR: 4480
File: v2/internal/frontend/desktop/darwin/message.h:17-19
Timestamp: 2025-08-08T09:13:16.916Z
Learning: In Wails v2 bindings origin verification, processBindingMessage intentionally has different signatures across platforms: Darwin includes an isMainFrame bool (WKWebKit provides it), Linux uses two params (message, source) as WebKitGTK doesn’t expose main-frame info there, and Windows handles origin checks in Go via WebView2 sender/args without a C bridge. This divergence is acceptable/expected per maintainer (APshenkin).
Applied to files:
docs/src/content/docs/contributing/architecture.mdx
📚 Learning: 2024-09-21T13:34:24.145Z
Learnt from: nixpare
Repo: wailsapp/wails PR: 3763
File: v3/pkg/application/webview_window_bindings_darwin.h:0-0
Timestamp: 2024-09-21T13:34:24.145Z
Learning: In this codebase, typedefs for window references (like replacing `void *` with `WindowRef`) are not preferred; using `void *` is acceptable.
Applied to files:
docs/src/content/docs/contributing/architecture.mdx
📚 Learning: 2024-09-20T23:34:29.841Z
Learnt from: nixpare
Repo: wailsapp/wails PR: 3763
File: v3/examples/keybindings/main.go:16-17
Timestamp: 2024-09-20T23:34:29.841Z
Learning: In the codebase, `application.Options.KeyBindings` uses the `application.Window` type, whereas `application.WebviewWindowOptions.KeyBindings` uses `*application.WebviewWindow`. This is intentional and acceptable.
Applied to files:
docs/src/content/docs/contributing/architecture.mdx
📚 Learning: 2025-10-17T23:16:11.570Z
Learnt from: Sammy-T
Repo: wailsapp/wails PR: 4570
File: v2/internal/frontend/desktop/linux/window_webkit6.go:97-108
Timestamp: 2025-10-17T23:16:11.570Z
Learning: For webkit_6/GTK4 builds in v2/internal/frontend/desktop/linux/window_webkit6.go, GTK widget creation should not be wrapped in invokeOnMainThread. The activation mechanism (activateWg + onActivate export) already handles thread safety, and additional wrapping would cause issues.
Applied to files:
docs/src/content/docs/contributing/architecture.mdx
📚 Learning: 2025-08-08T13:15:20.339Z
Learnt from: APshenkin
Repo: wailsapp/wails PR: 4484
File: v2/internal/frontend/utils/urlValidator.go:25-31
Timestamp: 2025-08-08T13:15:20.339Z
Learning: In Wails v2 (PR wailsapp/wails#4484), for BrowserOpenURL URL validation (v2/internal/frontend/utils/urlValidator.go), maintainers (APshenkin) prefer not to restrict schemes to an http/https allowlist because supported schemes may vary. The allowlist suggestion is declined; continue with the existing denylist approach and generic validation.
Applied to files:
docs/src/content/docs/guides/custom-protocol-association.mdx
⏰ 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). (1)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (8)
docs/src/content/docs/guides/custom-protocol-association.mdx (1)
130-132: Verify the Aside type change is intentional.The Aside type was changed from
"important"to"note", which reduces the visual emphasis. This note explains that Windows protocol schemes require installer registration, which seems like important information for developers to be aware of.Is this downgrade in severity intentional?
docs/package.json (1)
19-19: Nice addition of D2 diagram support!The addition of
astro-d2enables D2 diagram rendering in the documentation, which is being used in the architecture documentation files updated in this PR.docs/src/content/docs/contributing/architecture.mdx (3)
31-44: Excellent diagram label improvements!The updated labels consolidate multi-line text into concise single-line descriptions with inline clarifications (e.g., "Binding Generator (static analysis)", "Asset Server (dev)", etc.). This makes the diagrams more readable and self-contained.
95-108: Clear distinction between dev and prod modes.The updated labels now clearly indicate the differences between development and production asset serving with inline details like "(port 5173)", "(proxy + disk)", and "(read-only)". This helps readers quickly understand the operational differences.
124-131: Great addition of build tag annotations!Including the build tags (e.g.,
//go:build darwin) directly in the diagram labels helps developers immediately understand the platform-specific nature of these files without needing to check the source code.docs/src/content/docs/contributing/index.mdx (1)
56-75: Consistent diagram improvements across documentation.These label updates match the style improvements made in
architecture.mdx, consolidating multi-line labels into concise single-line descriptions with inline clarifications. The newDeveloper -> PKG: "compile & package"edge also adds clarity to the workflow..github/workflows/v3-docs.yml (1)
23-25: GitHub Actions versions are available and documented; verify upstream dependency compatibility.Both
actions/checkout@v5andwithastro/action@v5are released and available. Thewithastro/actionv5.0.0 release notes indicate the primary changes involve pinning dependencies for security and updatingupload-pages-artifactto v4.0.0, which has documented breaking changes. Verify that the site generation and upload workflow remain compatible with these dependency updates, particularlyupload-pages-artifactv4.docs/astro.config.mjs (1)
41-47: I need to search more specifically for Astro Starlight (the documentation theme) since the initial query was ambiguous. Let me search for the Astro Starlight documentation and changelog.Let me search for more information about the Starlight social configuration changes and breaking changes in v0.36.
No issues found - configuration matches current Starlight API.
The social configuration underwent a breaking change syntax update in Starlight that required updating astro.config.mjs when upgrading. The new format requires you to specify the icon and label for each social link explicitly using an array of objects with icon, label, and href properties. The configuration in your code correctly implements this updated format and is compatible with Starlight v0.36.x.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
v3/UNRELEASED_CHANGELOG.md (1)
4-4: Consider expanding changelog entries for clarity.The entries are accurate but generic. Per the PR description, this change includes Starlight upgrades, package version bumps (e.g.,
astro-d2), social config restructuring, and schema changes—not just Astro v5. Consider elaborating these entries to better reflect the full scope of changes for users and maintainers reviewing this release.Also applies to: 7-7
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/v3-docs.yml(1 hunks)v3/UNRELEASED_CHANGELOG.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-12-03T07:49:16.593Z
Learnt from: stavros-k
Repo: wailsapp/wails PR: 3917
File: docs/src/assets/contributors.astro:0-0
Timestamp: 2024-12-03T07:49:16.593Z
Learning: The table in 'docs/src/assets/contributors.astro' is autogenerated by another bot, so manual changes to it would be overwritten and are unnecessary.
Applied to files:
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: Run Go Tests v3 (macos-latest, 1.24)
- GitHub Check: Run Go Tests v3 (ubuntu-latest, 1.24)
- GitHub Check: Run Go Tests v3 (windows-latest, 1.24)
🔇 Additional comments (1)
.github/workflows/v3-docs.yml (1)
23-25: Verified: checkout action v5.0.0 commit hash is correct, andfetch-depth: 0is justified for Astro docs.The
fetch-depth: 0setting is needed for Astro's lastUpdated configuration to work as expected by fetching the whole git history. The checkout action version pin to commit08c6903cd8c0fde910a37f88322edcfb5dd907a8matches v5.0.0, and the version comment provides good maintainability.No changes needed.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
v3/UNRELEASED_CHANGELOG.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-12-03T07:49:16.593Z
Learnt from: stavros-k
Repo: wailsapp/wails PR: 3917
File: docs/src/assets/contributors.astro:0-0
Timestamp: 2024-12-03T07:49:16.593Z
Learning: The table in 'docs/src/assets/contributors.astro' is autogenerated by another bot, so manual changes to it would be overwritten and are unnecessary.
Applied to files:
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: Run Go Tests v3 (windows-latest, 1.24)
- GitHub Check: Run Go Tests v3 (macos-latest, 1.24)
- GitHub Check: Run Go Tests v3 (ubuntu-latest, 1.24)
|
|
I've got a ton of doc changes incoming so will need to come back to this 👍 |
2 participants
Description
The wails3 documentation website is many versions out of date, this PR fixes that by upgrading astro and starlight to their latest versions and fixes issues with the doc files stopping a compile on the older version or new.
npm run build in the docs folder now compiles a static website, which is viewable with npm run preview, that has the missing documentation.
The GitHub workflow has been updated to use the latest action versions for actions/checkout@v5 and withastro/action@v5
Summary by CodeRabbit
Documentation
Chores