Add backticks to format inline command

[osmanbowser]

Previously, it wasn't clear that wails init... was an inline command

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Add backticks to inline commands for clarity.

Type of change

Please select the option that is relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 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

If you checked Linux, please specify the distro and version.

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.

I don't believe this is necessary. But if it is, please advise.

Checklist:

• (v2 only) I have updated website/src/pages/changelog.mdx with details of this PR (v3 changelog entries are added automatically)
• 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

• Documentation
  • Improved formatting of command examples in the getting started guide for better readability and clarity.

[coderabbitai]

Walkthrough

Two wails init command examples in the Svelte tab of the v2.12.0 "First Project" documentation are changed from plain text to inline backtick code formatting. No logic, configuration, or exported entities are modified.

Changes

Docs Inline Code Fix

Layer / File(s)	Summary
Inline code formatting for Svelte init commands website/versioned_docs/version-v2.12.0/gettingstarted/firstproject.mdx	The wails init Svelte command and its TypeScript variant are wrapped in inline backticks for proper code rendering in the Svelte tab section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• wailsapp/wails#3878: Also modifies the firstproject documentation's "Project Generation" section, restructuring wails init command snippets for framework selection in a similar area of the file.

Suggested reviewers

• leaanthony

Poem

🐇 A backtick here, a backtick there,
The commands now shine with a code-like flair!
No more plain text lost in the docs,
The Svelte init ticks all the boxes.
Hop hop, formatting is quite the art! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding backticks to format inline commands in the documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description check	✅ Passed	PR description addresses the purpose of changes but is missing issue reference and changelog update confirmation.

_{✏️ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

🧹 Nitpick comments (1)

website/versioned_docs/version-v2.12.0/gettingstarted/firstproject.mdx (1)

31-35: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Consider applying consistent backtick formatting to all framework tabs.

The Svelte examples now use inline backticks for the wails init commands, but the React, Vue, Preact, Lit, and Vanilla tabs (lines 41, 45, 51, 55, 61, 65, 71, 75, 81, 85) still use plain text. For consistency across the entire tabbed section and alignment with broader documentation conventions, consider wrapping all wails init commands in backticks.

✨ Example: Formatting the React tab for consistency

<TabItem value="React">
    Generate a <a href={"https://reactjs.org/"}>React</a> project using JavaScript with:<br/><br/>

-    wails init -n myproject -t react
+    `wails init -n myproject -t react`

 If you would rather use TypeScript:<br/>

-    wails init -n myproject -t react-ts
+    `wails init -n myproject -t react-ts`

Apply the same pattern to Vue, Preact, Lit, and Vanilla tabs.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@website/versioned_docs/version-v2.12.0/gettingstarted/firstproject.mdx`
around lines 31 - 35, The Svelte framework tab currently uses inline backticks
for the wails init commands, but the React, Vue, Preact, Lit, and Vanilla tabs
use plain text formatting. Apply consistent backtick formatting by wrapping all
wails init command examples in backticks across every framework tab (React, Vue,
Preact, Lit, Vanilla, and Svelte) to maintain uniformity throughout the
documentation and align with broader documentation conventions.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@website/versioned_docs/version-v2.12.0/gettingstarted/firstproject.mdx`:
- Around line 31-35: The Svelte framework tab currently uses inline backticks
for the wails init commands, but the React, Vue, Preact, Lit, and Vanilla tabs
use plain text formatting. Apply consistent backtick formatting by wrapping all
wails init command examples in backticks across every framework tab (React, Vue,
Preact, Lit, Vanilla, and Svelte) to maintain uniformity throughout the
documentation and align with broader documentation conventions.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0a7424a5-0db5-49dc-b895-e88394bda358

📥 Commits

Reviewing files that changed from the base of the PR and between 3ec88c1 and 52172a2.

📒 Files selected for processing (1)

• website/versioned_docs/version-v2.12.0/gettingstarted/firstproject.mdx

[osmanbowser]

I opened #5653 to fix this for every web framework, not just Svelte.