docs(v2): add wails-template organization to templates#5033
docs(v2): add wails-template organization to templates#50332nthony wants to merge 1 commit intowailsapp:masterfrom
wails-template organization to templates#5033Conversation
📝 WalkthroughWalkthroughThe templates documentation has been reorganized to introduce a new "Framework templates" section, removing a specific Lit template entry and adding the wails-template organization as a centralized source for synced cross-framework templates. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@website/docs/community/templates.mdx`:
- Around line 84-86: The "## Framework templates" entry currently links to the
GitHub organization "wails-template" which cannot be passed directly to the
`wails init -t [url]` workflow; update the Framework templates section to either
(a) replace the organization link with direct links to one or more specific
template repositories from that org (so they work with `wails init -t
<repo-url>`), or (b) keep the org link but add a short clarifying note stating
that users must browse the organization and use individual repository URLs (git
clone-able repo links) with `wails init -t`; edit the text near the existing
list item referencing the organization link to implement one of these fixes.
| ## Framework templates | ||
|
|
||
| - [wails-template organization](https://github.com/wails-template) - An organization that provides up-to-date templates synced with other frameworks, such as Vite. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, find and examine the templates.mdx file to see the full context
find . -name "templates.mdx" -type fRepository: wailsapp/wails
Length of output: 11424
🏁 Script executed:
# Search for other template entries in the file to confirm the pattern
rg -A 2 -B 2 "## .*[Tt]emplate" website/docs/community/templates.mdx | head -100Repository: wailsapp/wails
Length of output: 471
🏁 Script executed:
# Look for the instruction on line 10 about wails init
rg "wails init" website/docs/community/templates.mdx -B 3 -A 3Repository: wailsapp/wails
Length of output: 686
🏁 Script executed:
# Read the full templates.mdx file to see all entries and context
cat -n website/docs/community/templates.mdxRepository: wailsapp/wails
Length of output: 7223
🏁 Script executed:
# Search for wails init command implementation to check if organization URLs are supported
rg "wails init" . -t go -t typescript -t javascript -A 5 | head -80Repository: wailsapp/wails
Length of output: 92
🏁 Script executed:
# Look for the init command implementation
fd -e go -e ts -e js . | xargs grep -l "init.*template" | grep -E "(cmd|command|init)" | head -10Repository: wailsapp/wails
Length of output: 78
🏁 Script executed:
# Search for how templates are resolved/loaded
rg "github.com" . -A 2 -B 2 | grep -E "(organization|org|template)" | head -30Repository: wailsapp/wails
Length of output: 5932
🏁 Script executed:
# Examine the init.go file to understand how templates are resolved
cat -n v2/cmd/wails/init.go | head -100Repository: wailsapp/wails
Length of output: 3290
🏁 Script executed:
# Look for template resolution logic
rg "template" v2/cmd/wails/init.go -A 3 -B 3 | head -80Repository: wailsapp/wails
Length of output: 2130
🏁 Script executed:
# Find and examine the templates package
find . -path "*/pkg/templates*" -name "*.go" -type fRepository: wailsapp/wails
Length of output: 867
🏁 Script executed:
# Look at the main templates file
cat -n v2/pkg/templates/templates.go | head -150Repository: wailsapp/wails
Length of output: 4531
🏁 Script executed:
# Find the Install function which handles template installation
rg "func.*Install" v2/pkg/templates/templates.go -A 50 | head -100Repository: wailsapp/wails
Length of output: 1569
🏁 Script executed:
# Search for how remote templates (github URLs) are handled
rg "github.com|http|remote" v2/pkg/templates/templates.go -B 3 -A 3 | head -80Repository: wailsapp/wails
Length of output: 1120
🏁 Script executed:
# Look at the complete Install function to understand remote template handling
sed -n '/^func Install/,/^func [A-Z]/p' v2/pkg/templates/templates.go | head -150Repository: wailsapp/wails
Length of output: 4137
🏁 Script executed:
# Check if there's any special handling for organization URLs
rg "github.com|organization|org" v2/pkg/templates/ -B 2 -A 2Repository: wailsapp/wails
Length of output: 50370
Clarify usage: organization link differs from the template pattern.
All other entries link directly to template repositories that work with wails init -t [url]. This entry links to a GitHub organization, which cannot be used directly with the wails init -t command as described in line 10 because git clone requires a specific repository URL, not an organization.
Consider either:
- Listing specific templates from the organization individually, or
- Adding a note explaining that users should browse the organization and use individual template URLs.
📝 Suggested clarification
## Framework templates
-- [wails-template organization](https://github.com/wails-template) - An organization that provides up-to-date templates synced with other frameworks, such as Vite.
+- [wails-template organization](https://github.com/wails-template) - An organization that provides up-to-date templates synced with other frameworks, such as Vite. Browse the repositories and use individual template URLs with `wails init -t`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Framework templates | |
| - [wails-template organization](https://github.com/wails-template) - An organization that provides up-to-date templates synced with other frameworks, such as Vite. | |
| ## Framework templates | |
| - [wails-template organization](https://github.com/wails-template) - An organization that provides up-to-date templates synced with other frameworks, such as Vite. Browse the repositories and use individual template URLs with `wails init -t`. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/docs/community/templates.mdx` around lines 84 - 86, The "## Framework
templates" entry currently links to the GitHub organization "wails-template"
which cannot be passed directly to the `wails init -t [url]` workflow; update
the Framework templates section to either (a) replace the organization link with
direct links to one or more specific template repositories from that org (so
they work with `wails init -t <repo-url>`), or (b) keep the org link but add a
short clarifying note stating that users must browse the organization and use
individual repository URLs (git clone-able repo links) with `wails init -t`;
edit the text near the existing list item referencing the organization link to
implement one of these fixes.
1 participant
I've added a cron job to automatically sync templates from other frameworks (starting with Vite). You can now find these in the https://github.com/wails-template which currently includes 16 newly synced templates from Vite.
I want to add it to the doc, but I don't know how to add the content correctly.
Description
add a templates organization.
Type of change
Please select the option that is relevant.
Summary by CodeRabbit
Documentation