docs: add desktop application (Tauri) development instructions#974
docs: add desktop application (Tauri) development instructions#974samarth-swami wants to merge 3 commits intoCircuitVerse:mainfrom
Conversation
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe README.md file was updated to include documentation for Desktop (Tauri) application development. A new Desktop (Tauri) section was added containing prerequisites (Node.js, npm, Rust, and macOS tools), installation steps for dependencies, and commands for running development and production builds ( 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
170-170:⚠️ Potential issue | 🟡 MinorStale TODO — "Creating the desktop application" should be removed or updated.
The Tauri desktop app is now implemented (CI workflow exists, docs being added here). Leaving it in the To Dos list is misleading.
📄 Proposed fix
-4. **Creating the desktop application**🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 170, Remove or update the stale "Creating the desktop application" TODO entry in the README's To Dos list: locate the heading/text "Creating the desktop application" and either delete that list item or replace it with an updated status note (e.g., "Tauri desktop app implemented — see CI workflow and docs") and ensure any related checklist/links are accurate and no longer present as an outstanding task.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 59-89: The new "## Desktop (Tauri) — Prerequisites & running"
section is placed between the "## Build System" header and its "### Custom
Mounting Point" subsection, breaking the document hierarchy; move the entire "##
Desktop (Tauri) — Prerequisites & running" block so it appears after the "###
Custom Mounting Point" subsection and before any subsequent top-level sections,
ensuring "### Custom Mounting Point" remains nested under "## Build System".
Update the README by cutting the "## Desktop (Tauri) — Prerequisites & running"
header and its content and pasting it immediately after the end of the "###
Custom Mounting Point" content.
- Line 65: Update the README line that currently reads "Node.js (recommended:
16+ / compatible LTS)" to recommend a maintained LTS version; replace it with
"Node.js (recommended: 20+ / compatible LTS)" (or alternatively "18+ /
compatible LTS" if you want broader compatibility) so the minimum/recommended
Node.js version reflects current Active LTS; locate the exact string "Node.js
(recommended: 16+ / compatible LTS)" and change it accordingly.
- Around line 63-68: Extend the "Prerequisites (minimum):" section so
platform-specific Tauri prerequisites are listed alongside the existing macOS
note: add a Linux bullet (referencing package examples like
libwebkit2gtk-4.1-dev, build-essential, libssl-dev and mention distribution
variation) and a Windows bullet (mention MSVC C++ Build Tools and Microsoft Edge
WebView2), mirroring the macOS line's format and placing them with the
Node.js/npm/Rust/cargo items under the same header to ensure contributors on
Linux and Windows see the additional requirements.
- Line 88: Update the Tauri prerequisites URL in README.md by replacing the
existing v1 link "https://tauri.app/v1/guides/getting-started/prerequisites"
with the v2 link "https://v2.tauri.app/start/prerequisites/" so the README
reflects the project's Tauri 2.x dependency.
---
Outside diff comments:
In `@README.md`:
- Line 170: Remove or update the stale "Creating the desktop application" TODO
entry in the README's To Dos list: locate the heading/text "Creating the desktop
application" and either delete that list item or replace it with an updated
status note (e.g., "Tauri desktop app implemented — see CI workflow and docs")
and ensure any related checklist/links are accurate and no longer present as an
outstanding task.
|
Hey @samarth-swami Could you please remove unrelated changes, including files such as |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
174-174:⚠️ Potential issue | 🟡 MinorStale To-Do item — remove or update "Creating the desktop application".
The Tauri desktop application already exists and this PR documents it. Leaving this item as a pending to-do is misleading to contributors.
✂️ Proposed fix
-4. **Creating the desktop application**🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 174, Remove or update the stale to-do heading "Creating the desktop application" in README.md: locate the header text "Creating the desktop application" and either delete that list item entirely or replace it with a note that the Tauri desktop app already exists and link to its documentation/PR; ensure the README no longer presents this as a pending task so contributors aren't misled.
🧹 Nitpick comments (2)
README.md (2)
72-103: Desktop (Tauri) section looks good — all prior review concerns addressed.The section is now correctly positioned after
### Custom Mounting Point, preserving the## Build Systemhierarchy. Node.js version is updated to20+ / Active LTS, Linux/Windows prerequisites are present, and the docs link points to the Tauri v2 prerequisites page.One optional style nit: the plain
Note:prefix on line 103 could be a Markdown blockquote to render more prominently.✨ Optional formatting tweak
-Note: If you haven't installed the Tauri CLI or other native prerequisites, follow the official Tauri setup docs for your platform: https://v2.tauri.app/start/prerequisites/ +> **Note:** If you haven't installed the Tauri CLI or other native prerequisites, follow the official Tauri setup docs for your platform: https://v2.tauri.app/start/prerequisites/🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 72 - 103, Replace the plain "Note:" line under the "## Desktop (Tauri) — Prerequisites & running" section with a Markdown blockquote so the note is rendered prominently; locate the header "Desktop (Tauri) — Prerequisites & running" and the subsequent paragraph that begins with "Note:" and convert that paragraph into a blockquote (prefix with >) to improve visual emphasis.
104-106: Three consecutive blank lines — reduce to one.Multiple blank lines render identically in Markdown; one is enough.
✂️ Proposed fix
...follow the official Tauri setup docs for your platform: https://v2.tauri.app/start/prerequisites/ - - - + ## Route-Agnostic Support🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 104 - 106, There are three consecutive blank lines in the README; reduce them to a single blank line by deleting the extra two blank lines so only one empty line remains between the surrounding paragraphs/sections (edit the block of consecutive newlines around the current triple-blank area).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@README.md`:
- Line 174: Remove or update the stale to-do heading "Creating the desktop
application" in README.md: locate the header text "Creating the desktop
application" and either delete that list item entirely or replace it with a note
that the Tauri desktop app already exists and link to its documentation/PR;
ensure the README no longer presents this as a pending task so contributors
aren't misled.
---
Nitpick comments:
In `@README.md`:
- Around line 72-103: Replace the plain "Note:" line under the "## Desktop
(Tauri) — Prerequisites & running" section with a Markdown blockquote so the
note is rendered prominently; locate the header "Desktop (Tauri) — Prerequisites
& running" and the subsequent paragraph that begins with "Note:" and convert
that paragraph into a blockquote (prefix with >) to improve visual emphasis.
- Around line 104-106: There are three consecutive blank lines in the README;
reduce them to a single blank line by deleting the extra two blank lines so only
one empty line remains between the surrounding paragraphs/sections (edit the
block of consecutive newlines around the current triple-blank area).
|
@naman79820 Thank you for review! All feedback has been addressed. |
2 participants
Fixes #509
Describe the changes you have made in this PR - Fixes #509
Adds documentation for desktop application development using Tauri,
including prerequisites and dev/build commands.
Screenshots of the UI changes (If any) -
N/A (documentation-only changes)
Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
Explain your implementation approach:
This PR adds missing documentation for running and building the desktop
application using Tauri. The goal was to make it easier for contributors
to set up the desktop environment by clearly listing prerequisites and
the required npm commands, without changing any existing functionality.
Checklist before requesting a review
Summary by CodeRabbit