Skip to content

chore: removed incorrect go.mod instructions#3878

Merged
leaanthony merged 4 commits into
wailsapp:masterfrom
damiensedgwick:damien/chore/update-documentation-for-gomod-file
Nov 16, 2024
Merged

chore: removed incorrect go.mod instructions#3878
leaanthony merged 4 commits into
wailsapp:masterfrom
damiensedgwick:damien/chore/update-documentation-for-gomod-file

Conversation

@damiensedgwick

@damiensedgwick damiensedgwick commented Nov 4, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

This change removes references of The default module name in go.mod is "changeme". You should change this to something more appropriate. which are no longer necessary as creating a new wails project uses the project name correctly.

Fixes #3877

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

I have checked both windows and linux as I am using WSL.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Using WSL I built and served the documentation website and confirmed that the unnecessary message is no longer being displayed.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features

    • Introduced a tabbed interface for project generation using the wails init command, supporting frameworks like Svelte, React, Vue, Preact, Lit, and Vanilla.
    • Enhanced documentation clarity regarding the project layout and directory structure.
    • Added community templates and references to CLI help for additional options.

  • Bug Fixes

    • Removed outdated note about changing the default module name in go.mod, simplifying instructions.

  • Documentation

    • Updated various sections to improve usability and clarity for new users setting up Wails projects.

@coderabbitai

coderabbitai Bot commented Nov 4, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The documentation for creating a project with Wails has been updated to enhance clarity and usability. Key changes include the introduction of a tabbed interface for selecting frameworks like Svelte, React, and Vue, along with specific commands for project generation in JavaScript and TypeScript. The project layout section has been refined to clearly describe the directory structure, while a previous note regarding the default module name in go.mod has been removed, simplifying the instructions.

Changes

File Path Change Summary
website/docs/gettingstarted/firstproject.mdx Updated to include detailed instructions for project generation using wails init, introduced a tabbed interface for framework selection, refined project layout section, and removed note about default module name in go.mod.
website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx Added new section on project generation with wails init, introduced tabbed interface for framework selection, clarified project layout, and retained note about changing default module name in go.mod.
website/i18n/tr/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx Updated to include project generation section with wails init, introduced tabbed interface for framework selection, retained project layout details, and removed note about default module name in go.mod.
website/i18n/vi/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx Document updated with project generation section using wails init, introduced tabbed interface for framework selection, retained project layout details, and removed note about default module name in go.mod.
website/src/pages/changelog.mdx Updated changelog to reflect changes in documentation, including removal of the note about the default module name in go.mod, and added entries for new features and bug fixes.
website/versioned_docs/version-v2.8.1/gettingstarted/firstproject.mdx Updated to include project generation section with wails init, introduced tabbed interface for framework selection, clarified project layout, and specified default module name in go.mod.
website/versioned_docs/version-v2.9.0/gettingstarted/firstproject.mdx Introduced new section on project generation using wails init, detailed tabbed interface for framework selection, outlined project layout, and advised changing default module name in go.mod.

Assessment against linked issues

Objective Addressed Explanation
Remove unnecessary instruction for updating go.mod file (3877) ✅

Possibly related PRs

Suggested reviewers

  • leaanthony

🐰 "In the garden of code, we hop with glee,
New projects await, as easy as can be!
With tabs for each framework, so clear and bright,
Wails makes it simple, a pure delight!
So gather your tools, let’s start the show,
With each little change, our skills will grow!" 🐇✨

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.

@damiensedgwick damiensedgwick marked this pull request as ready for review November 4, 2024 17:02
@leaanthony

leaanthony commented Nov 4, 2024

Copy link
Copy Markdown
Member

Nice find!🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

@damiensedgwick

damiensedgwick commented Nov 5, 2024

Copy link
Copy Markdown
Contributor Author

Nice find!🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

Thank you. I did add to the changelog yesterday after I spotted the checkbox in the PR description., if you could let me know if anything needs changing and then I can address it later.

image

@leaanthony

leaanthony commented Nov 5, 2024

Copy link
Copy Markdown
Member

I must have responded to an older version of this page :-)

@leaanthony leaanthony enabled auto-merge (squash) November 5, 2024 21:14
@sonarqubecloud

sonarqubecloud Bot commented Nov 11, 2024

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@damiensedgwick

damiensedgwick commented Nov 11, 2024

Copy link
Copy Markdown
Contributor Author

Do I have to do anything else here @leaanthony or will it just get picked up when it gets picked up? I merged master back in so it didn't fall too far behind.

@leaanthony leaanthony disabled auto-merge November 16, 2024 00:04
@leaanthony leaanthony merged commit 10e3a13 into wailsapp:master Nov 16, 2024
@leaanthony

leaanthony commented Nov 16, 2024

Copy link
Copy Markdown
Member

Thanks for this! 🙏

This was referenced Nov 16, 2024
Merged
Merged
Merged
Merged
Merged
@coderabbitai coderabbitai Bot mentioned this pull request Nov 23, 2024
Closed
@coderabbitai coderabbitai Bot mentioned this pull request Dec 1, 2024
Merged
15 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Dec 30, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leaanthony leaanthony leaanthony approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Unnecessary instruction for updating go.mod file for new projects.

2 participants

@damiensedgwick @leaanthony