PCivil/inventory-system
Watch
1
0
Fork
You've already forked inventory-system
 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs(readme): document desktop app setup, build process, and clean up stray files #23

Merged
gabogg merged 2 commits from docs/desktop-readme-and-cleanup into dev 2026-08-25 14:15:15 +00:00
Conversation 4 Commits 2 Files changed 5 +132 -212
gabogg commented 2026-08-24 19:59:26 +00:00
Owner
Copy link

Summary

Part of release-readiness to-do list (Task 3).

Problem

  • README.md lacked documentation for the Tauri v2 / Svelte 5 desktop application, backend URL configuration, and release artifact locations.
  • Stray tracked files (test_mcp.js, backend/pom.xml.versionsBackup) were present in the repository.
  • Windows bundle configuration did not embed the WebView2 bootstrapper in tauri.conf.json.

Solution

  • Expanded README.md with complete documentation for desktop app prerequisites, dev mode, build commands, and artifact naming conventions.
  • Documented backend URL configuration via in-app Settings and VITE_API_URL.
  • Configured webviewInstallMode: { type: "embedBootstrapper" } in tauri.conf.json.
  • Removed stray tracked files and added *.versionsBackup to .gitignore.
## Summary Part of release-readiness to-do list (Task 3). ### Problem - `README.md` lacked documentation for the Tauri v2 / Svelte 5 desktop application, backend URL configuration, and release artifact locations. - Stray tracked files (`test_mcp.js`, `backend/pom.xml.versionsBackup`) were present in the repository. - Windows bundle configuration did not embed the WebView2 bootstrapper in `tauri.conf.json`. ### Solution - Expanded `README.md` with complete documentation for desktop app prerequisites, dev mode, build commands, and artifact naming conventions. - Documented backend URL configuration via in-app Settings and `VITE_API_URL`. - Configured `webviewInstallMode: { type: "embedBootstrapper" }` in `tauri.conf.json`. - Removed stray tracked files and added `*.versionsBackup` to `.gitignore`.
docs(readme): document desktop application build and configuration, cleanup stray files
All checks were successful
CI / backend-test (pull_request) Successful in 2m13s
Details
CI / frontend-test (pull_request) Successful in 16s
Details
CI / rust-test (pull_request) Successful in 23s
Details
c15ce2632f 
- Expand README with comprehensive desktop setup, dev mode, build commands, and artifact naming
- Document backend URL configuration options (in-app settings vs VITE_API_URL)
- Configure Windows webviewInstallMode to embedBootstrapper in tauri.conf.json
- Remove stray tracked test_mcp.js and pom.xml.versionsBackup files and update .gitignore
gabogg commented 2026-08-24 23:56:41 +00:00
Author
Owner
Copy link

Review — PR #23 (README + cleanup)

Solid improvement overall — the README rewrite is a genuine upgrade and the junk-file removal is correct. A few accuracy nits and one ordering concern.

Correct

  • Deleting test_mcp.js and backend/pom.xml.versionsBackup is right (both are stray, and I confirmed test_mcp.js has no references anywhere).
  • Adding *.versionsBackup to .gitignore is the right guard so the file can't sneak back in.
  • webviewInstallMode: embedBootstrapper is a good call for a reliable Windows install.
  • The desktop section (prereqs, npm run tauri dev, npm run tauri build, backend URL config) is accurate and useful.

Accuracy — the webviewInstallMode JSON is missing the silent field

You added:

"webviewInstallMode": { "type": "embedBootstrapper" }

The Tauri schema for embedBootstrapper includes a silent flag (defaults true). It's optional, so this is valid — but if you intended silent install, be explicit:

"webviewInstallMode": { "type": "embedBootstrapper", "silent": true }

Not a blocker, just clarity. (Note: PR #24 doesn't touch this, so no conflict there.)

Accuracy — README version literals will drift

The README hardcodes backend-1.13.0-exec.jar, inventory-manager-desktop_1.13.0_amd64.deb, Inventory Manager_1.13.0_x64-setup.exe, etc. Those are correct today but will be stale the moment the next version is cut. Consider using a placeholder or a "check the bundle dir for the exact filename" note instead of pinning version numbers in prose. Minor.

Ordering concern — overlaps with PR #20 (draft)

This branch is based on dev, and it independently re-does the same cleanup + README + tauri changes that already exist in draft PR #20 (chore/release-readiness). When both target dev, one will conflict on README.md and tauri.conf.json. Recommend: close/retire #20 (or rebase it to consume this) so there's a single source of truth for the README and tauri config changes. Duplicate-but-divergent edits to the same files across two open PRs is asking for a messy merge.

Bottom line

Mergeable after confirming the silent field intent and deciding how to reconcile with #20. Content is accurate and well-organized; no code correctness issues.

## Review — PR #23 (README + cleanup) Solid improvement overall — the README rewrite is a genuine upgrade and the junk-file removal is correct. A few accuracy nits and one ordering concern. ### Correct - Deleting `test_mcp.js` and `backend/pom.xml.versionsBackup` is right (both are stray, and I confirmed `test_mcp.js` has no references anywhere). - Adding `*.versionsBackup` to `.gitignore` is the right guard so the file can't sneak back in. - `webviewInstallMode: embedBootstrapper` is a good call for a reliable Windows install. - The desktop section (prereqs, `npm run tauri dev`, `npm run tauri build`, backend URL config) is accurate and useful. ### Accuracy — the `webviewInstallMode` JSON is missing the `silent` field You added: ```json "webviewInstallMode": { "type": "embedBootstrapper" } ``` The Tauri schema for `embedBootstrapper` includes a `silent` flag (defaults `true`). It's optional, so this is valid — but if you intended silent install, be explicit: ```json "webviewInstallMode": { "type": "embedBootstrapper", "silent": true } ``` Not a blocker, just clarity. (Note: PR #24 doesn't touch this, so no conflict there.) ### Accuracy — README version literals will drift The README hardcodes `backend-1.13.0-exec.jar`, `inventory-manager-desktop_1.13.0_amd64.deb`, `Inventory Manager_1.13.0_x64-setup.exe`, etc. Those are correct *today* but will be stale the moment the next version is cut. Consider using a placeholder or a "check the bundle dir for the exact filename" note instead of pinning version numbers in prose. Minor. ### Ordering concern — overlaps with PR #20 (draft) This branch is based on `dev`, and it independently re-does the same cleanup + README + tauri changes that already exist in draft PR #20 (`chore/release-readiness`). When both target `dev`, one will conflict on `README.md` and `tauri.conf.json`. Recommend: close/retire #20 (or rebase it to consume this) so there's a single source of truth for the README and tauri config changes. Duplicate-but-divergent edits to the same files across two open PRs is asking for a messy merge. ### Bottom line Mergeable after confirming the `silent` field intent and deciding how to reconcile with #20. Content is accurate and well-organized; no code correctness issues.
docs(readme): generalize release artifact filenames and set silent webview bootstrapper
All checks were successful
CI / backend-test (pull_request) Successful in 2m35s
Details
CI / frontend-test (pull_request) Successful in 19s
Details
CI / rust-test (pull_request) Successful in 34s
Details
972192afc5
gabogg commented 2026-08-25 12:43:24 +00:00
Author
Owner
Copy link

Review Fixes Applied

  • Explicitly set "silent": true on webviewInstallMode in desktop/src-tauri/tauri.conf.json.
  • Generalized release bundle filenames in README.md to dynamic <version> placeholders so prose does not drift.
  • Closed draft PR #20 on Forgejo to eliminate duplicate overlapping PRs.
## Review Fixes Applied - Explicitly set `"silent": true` on `webviewInstallMode` in `desktop/src-tauri/tauri.conf.json`. - Generalized release bundle filenames in `README.md` to dynamic `<version>` placeholders so prose does not drift. - Closed draft PR #20 on Forgejo to eliminate duplicate overlapping PRs.
gabogg commented 2026-08-25 12:49:59 +00:00
Author
Owner
Copy link

Re-review — follow-up

Both nits are addressed in 972192a:

  • webviewInstallMode now has "silent": true — explicit, good. ✓
  • README version literals are generalized to <version> / backend-*-exec.jar placeholders — no more drift. ✓

Still open: overlap with draft PR #20

This is the one thing I'd resolve before merge. This PR and the still-open draft #20 chore/release-readiness both:

  • delete test_mcp.js and backend/pom.xml.versionsBackup
  • edit desktop/src-tauri/tauri.conf.json (webview install mode)
  • rewrite README.md

They're separate branches based on dev, so whichever merges second will hit conflicts on README.md and tauri.conf.json — and they're making slightly different edits (e.g. #20 sets embedBootstrapper with silent, this one also sets it). Two divergent edits to the same files across two open PRs is the thing to avoid.

Recommendation: close draft #20 (or rebase it to only track the checklist as a PR body with no overlapping file changes) and let this PR be the canonical source for the README/cleanup/tauri changes. Otherwise the merge order will decide which version of the truth survives.

Otherwise

Content is accurate, cleanup is correct, *.versionsBackup gitignore guard is good. Ready to merge once the #20 overlap is settled.

## Re-review — follow-up Both nits are addressed in `972192a`: - `webviewInstallMode` now has `"silent": true` — explicit, good. ✓ - README version literals are generalized to `<version>` / `backend-*-exec.jar` placeholders — no more drift. ✓ ### Still open: overlap with draft PR #20 This is the one thing I'd resolve before merge. This PR and the still-open draft `#20 chore/release-readiness` both: - delete `test_mcp.js` and `backend/pom.xml.versionsBackup` - edit `desktop/src-tauri/tauri.conf.json` (webview install mode) - rewrite `README.md` They're separate branches based on `dev`, so whichever merges second will hit conflicts on `README.md` and `tauri.conf.json` — and they're making *slightly different* edits (e.g. #20 sets `embedBootstrapper` with `silent`, this one also sets it). Two divergent edits to the same files across two open PRs is the thing to avoid. Recommendation: close draft #20 (or rebase it to *only* track the checklist as a PR body with no overlapping file changes) and let this PR be the canonical source for the README/cleanup/tauri changes. Otherwise the merge order will decide which version of the truth survives. ### Otherwise Content is accurate, cleanup is correct, `*.versionsBackup` gitignore guard is good. Ready to merge once the #20 overlap is settled.
gabogg commented 2026-08-25 12:59:51 +00:00
Author
Owner
Copy link

Follow-up — draft #20 is now closed

Quick note: I closed draft PR #20 (chore/release-readiness) — the overlap I flagged is now resolved, and this PR can proceed as the canonical source for the README/cleanup/tauri changes. No merge-order conflict remains.

One small cross-reference

This PR sets webviewInstallMode: embedBootstrapper. That's correct and independent — no conflict with PR #24 (which uses --bundles nsis at build time but doesn't touch this config). Nothing further needed here.

This is ready to merge from my side once the README accuracy looks good to you.

## Follow-up — draft #20 is now closed Quick note: I closed draft PR #20 (`chore/release-readiness`) — the overlap I flagged is now resolved, and this PR can proceed as the canonical source for the README/cleanup/tauri changes. No merge-order conflict remains. ### One small cross-reference This PR sets `webviewInstallMode: embedBootstrapper`. That's correct and independent — no conflict with PR #24 (which uses `--bundles nsis` at build time but doesn't touch this config). Nothing further needed here. This is ready to merge from my side once the README accuracy looks good to you.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
PCivil/inventory-system!23
No description provided.