Skip to content

Updated documentation with new wails template#3820

Merged
leaanthony merged 1 commit into
wailsapp:masterfrom
tongque0:master
Oct 13, 2024
Merged

Updated documentation with new wails template#3820
leaanthony merged 1 commit into
wailsapp:masterfrom
tongque0:master

Conversation

@tongque0

@tongque0 tongque0 commented Oct 12, 2024

Copy link
Copy Markdown
Contributor

Updated documentation with new Vue-based Wails template

Created a new Wails template using the latest version of Vue, TDesign, and Vue Router. This PR only updates the documentation on the Wails website to include the new template.

Fixes

N/A

Type of change

  • Documentation update.

PS

This template uses the latest technologies such as Vue 3, Vite, TDesign (a component library open-sourced by Tencent), Vue Router, and Pinia for state management, providing developers with more choices for building modern applications.

Summary

  • New Features:
    • Added a new community-supported template for Vue users:
      • wails-template-tdesign-js: Integrates Wails, Vue 3, Vite, TDesign, Vue Router, and Pinia.

This template is fully up to date with the latest versions of Vue, TDesign, Vue Router, Pinia, and other supporting libraries.

Summary by CodeRabbit

  • New Features
    • Added a new template for TDesign UI in the community-supported templates documentation for Vue.
    • Available in both English and Chinese documentation, enhancing accessibility for users.

@coderabbitai

coderabbitai Bot commented Oct 12, 2024

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request introduces a new template entry in the documentation for Wails, specifically within the community-supported templates section. It adds the [wails-template-tdesign-js], which is based on the TDesign UI, a Vue 3 UI library developed by Tencent. This addition is made in both the English and Chinese versions of the documentation, under the existing Vue section, while maintaining the overall structure of the documents.

Changes

File Path Change Summary
website/docs/community/templates.mdx Added new template entry: [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) for TDesign UI in the Vue section.
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community/templates.mdx Added new template entry: [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) for TDesign UI in the Vue section (Chinese version).

Possibly related PRs

  • Updated documentation with new wails template #3802: This PR updates the documentation to include new templates in the Svelte section, similar to how the main PR adds a new template in the Vue section, indicating a related effort to enhance community-supported templates in the Wails documentation.

Poem

🐇 In the garden of code where templates bloom,
A new TDesign sprout finds its room.
With Vue and Vite, it hops along,
Bringing joy to projects, where it belongs.
So let’s celebrate this template's debut,
A gift for developers, fresh and new! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sonarqubecloud

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community/templates.mdx (1)

29-29: LGTM! Consider adding an English translation.

The new template entry is correctly formatted and placed in the appropriate section. The description provides relevant information about the template's features and technologies used.

As an enhancement, consider adding an English translation of the description in parentheses, similar to other multilingual documentation practices. This would improve accessibility for non-Chinese speaking users who might be viewing this file.

Here's a suggested addition:

- [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) - 基于 TDesign UI(腾讯的 Vue 3 组件库)的 Wails 模板,使用 Vite、Pinia、Vue Router、ESLint 和 Prettier。
+ [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) - 基于 TDesign UI(腾讯的 Vue 3 组件库)的 Wails 模板,使用 Vite、Pinia、Vue Router、ESLint 和 Prettier。(Wails template based on TDesign UI (Tencent's Vue 3 component library), using Vite, Pinia, Vue Router, ESLint, and Prettier.)
website/docs/community/templates.mdx (1)

30-30: LGTM! Consider adding a version tag to the template link.

The new template entry is well-placed in the Vue section and follows the existing format. The description provides a clear overview of the template's features. This addition aligns perfectly with the PR objectives.

As a minor suggestion, consider adding a version tag to the template link to ensure users get a stable version. For example:

[wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js@v1.0.0)

Replace v1.0.0 with the appropriate version tag.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 10abe24 and 93d40ae.

📒 Files selected for processing (2)
  • website/docs/community/templates.mdx (1 hunks)
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community/templates.mdx (1 hunks)
🧰 Additional context used

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants