Skip to content

docs: Added new, updated templates for Solidjs, template base changes#5088

Open
theluqmn wants to merge 4 commits intowailsapp:masterfrom
theluqmn:master
Open

docs: Added new, updated templates for Solidjs, template base changes#5088
theluqmn wants to merge 4 commits intowailsapp:masterfrom
theluqmn:master

Conversation

@theluqmn
Copy link
Copy Markdown

@theluqmn theluqmn commented Mar 27, 2026

Summary of changes:

  1. Added two new templates to the community templates page, under Solidjs. I made these templates as the previous template has gotten outdated and does not work on Windows.
  2. Added a very short "Template Usage" section which includes the command to run in order to use the template.
  3. Modified the NEXTSTEPS accordingly.

This is also my first ever contribution on a major public repository! I hope the maintainers appreciate this little quality-of-life improvement. I tried looking for a PR template that works with what I'm doing, but didn't seem to find any. No AI used here at all btw, just pure manual labour (very painful). Thanks! Looking forward to work with Wails more.

Summary by CodeRabbit

  • Documentation
    • Clarified template initialization guidance, with explicit steps to update README and replace the template repository URL so new templates point to the correct source.
    • Added a “Template Usage” section showing how to initialize projects using the wails init command with name and template flags.
    • Added two new Solid.js community template options for quicker project starts.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 78e676a4-0c7b-454e-aadf-7165ddf691be

📥 Commits

Reviewing files that changed from the base of the PR and between 72a1bc5 and 326edaf.

📒 Files selected for processing (1)
  • website/docs/community/templates.mdx
✅ Files skipped from review due to trivial changes (1)
  • website/docs/community/templates.mdx

📝 Walkthrough

Walkthrough

This PR updates Wails template documentation: clarifies step 2 in the NEXTSTEPS template to instruct replacing your-template-url with the template repository URL, adds a "Template Usage" section to the base README with a wails init -n -t example, and adds two Solid.js community template entries to the website docs.

Changes

Cohort / File(s) Summary
Template Base Files
v2/cmd/wails/internal/template/base/NEXTSTEPS.md.template, v2/cmd/wails/internal/template/base/README.md
Clarified NEXTSTEPS step 2 to explicitly tell users to replace your-template-url with the template repo URL; added a "Template Usage" section showing wails init -n -t <template> example.
Community Templates Documentation
website/docs/community/templates.mdx
Added two Solid.js community template links: wails-solid-js and wails-solid-js-tailwind under the Solid section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

Documentation, To Be Documented, size:XS, Windows, lgtm

Suggested reviewers

  • leaanthony

Poem

🐰 I hopped through docs to make things bright,
Replaced the placeholder, set the URL right,
Added usage steps and Solid seeds,
Templates sprout fast with tiny deeds,
Happy builds and bouncy bytes! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the changes and motivation but lacks required checklist items, test configuration details, and does not reference a linked issue as required by the template. Complete the PR template checklist items, add test configuration from 'wails doctor', reference a linked issue with 'Fixes #', and indicate the type of change. These items are required per the repository's submission guidelines.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: adding new Solidjs templates to the community templates page and updating the template base (NEXTSTEPS.md and README.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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`:
- Line 65: The second link uses the same label "[wails-solid-js]" as the
previous entry but points to a different repo; change the link label for the
Tailwind template to a distinct name (for example "wails-solid-js-tailwind" or
"wails-solid-js (Tailwind)") while keeping the URL
https://github.com/theluqmn/wails-solid-js-tailwind and the rest of the line
intact so the two entries are no longer ambiguous.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b1047d6d-ffe7-4288-b25f-654ca054fc7d

📥 Commits

Reviewing files that changed from the base of the PR and between ebe9d32 and 72a1bc5.

📒 Files selected for processing (3)
  • v2/cmd/wails/internal/template/base/NEXTSTEPS.md.template
  • v2/cmd/wails/internal/template/base/README.md
  • website/docs/community/templates.mdx

Comment thread website/docs/community/templates.mdx Outdated
@leaanthony
Copy link
Copy Markdown
Member

Triaged by Wails PR Reviewer

This PR has been reviewed and accepted.

Head Ref OID: 326edaf22dda1edd9ab0492772095edd4b08572f


This comment serves as a signature that this PR has been triaged. Future runs will skip this PR based on the headRefOid.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants