[swastiksharma45]

Closes #1664

• Migrate examples to Tauri v2 (@tauri-apps/api/core)
• Fix undefined serverPath reference in get_resources_folder_path example
• Document all 13 registered IPC commands with signatures, source files, params, returns and examples
• Document memory:pending and memory:open events with a listen pattern
• Passes markdownlint with the repo config

Summary by CodeRabbit

• Documentation
  • Expanded the backend API reference with Tauri v2 IPC commands and events, including command arguments, return values, validation rules, and invocation examples.
  • Added guidance for subscribing to memory events and handling Windows path prefixes when opening image files. The reference also replaces earlier brief resource-path documentation and a Tauri v1 import example.

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 27 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

Run configuration

• Source mode: Auto
• Repository: AOSSIE-Org/PictoPy
• Branch: dev
• File: .coderabbit.yaml
• Commit: d700442
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: 098fd234-bc3b-42f6-9e6c-1f04873bebcb

Commits

Reviewing files that changed from the base of the PR and between 6878fab and c40ccd1.

Files selected for processing: 1

• docs/backend/backend_rust/api.md

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: AOSSIE-Org/PictoPy
• Branch: dev
• File: .coderabbit.yaml
• Commit: d700442
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: a637e45b-0444-4526-b1ce-777ac00dca0d

Commits

Reviewing files that changed from the base of the PR and between 5796b0c and 6878fab.

Files selected for processing: 1

• docs/backend/backend_rust/api.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

Walkthrough

The Rust backend API guide now describes Tauri v2 invocation, registered IPC commands, memory events and subscription patterns, and platform-specific path handling.

Changes

Rust backend API documentation

Layer / File(s)	Summary
Invocation and file access docs/backend/backend_rust/api.md	The guide describes Tauri v2 invocation conventions, resource-path lookup, image-file path checks, and Windows path-prefix handling.
Tunnel and system controls docs/backend/backend_rust/api.md	The guide documents tunnel commands, Model Manager access, close-to-tray preferences, and login autostart commands.
Memory commands and events docs/backend/backend_rust/api.md	The guide documents memory commands, event payloads, and a subscription pattern that registers listeners, retrieves pending announcements, retains undelivered announcements, and deduplicates delivery by memory_id.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

• AOSSIE-Org/PictoPy#1440: Adds the memory events and commands that this guide documents.

Suggested reviewers: rahulharpal1603, animeshchaudhri

Merge Risk: Low · previous review 6878f

The documentation’s memory subscription example can miss a one-shot navigation event during setup. This is a bounded documentation risk, but the example should be corrected before relying on it as the recommended pattern.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: updating the Rust API documentation for Tauri v2 and documenting all IPC commands.
Linked Issues check		Issue #1664 requirements are met. docs/backend/backend_rust/api.md uses the Tauri v2 @tauri-apps/api/core import and fixes the resource-path example. It documents all 13 IPC commands with signatur…
Out of Scope Changes check		The reviewed change is limited to docs/backend/backend_rust/api.md. The documented validation rules and Windows path-prefix handling support the API documentation objective. No unrelated source, rel…

Full details: Linked Issues check

Explanation

Issue #1664 requirements are met. docs/backend/backend_rust/api.md uses the Tauri v2 @tauri-apps/api/core import and fixes the resource-path example. It documents all 13 IPC commands with signatures, arguments, return values, source locations, and TypeScript examples. It documents memory:pending and memory:open with the listen subscription pattern. The PR reports compliance with .github/.markdownlint-cli2.jsonc.

Full details: Out of Scope Changes check

Explanation

The reviewed change is limited to docs/backend/backend_rust/api.md. The documented validation rules and Windows path-prefix handling support the API documentation objective. No unrelated source, release, or administrative changes are present in the reviewed summary.

Finishing Touches

Generate unit tests (beta)

• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

_{A rabbit reads the commands with care,
Tauri v2 imports now greet the air.
Memory notes arrive in pairs,
Listeners wait and sort their shares.
The path signs point through Windows snow,
Then off the rabbit hops to go.}

[coderabbitai]

• Fix comments: Fix CodeRabbit comments on this PR

[gitcordapp]

Link your account with Gitcord

Thanks for opening this PR, @swastiksharma45!

To receive Discord notifications and contributor tracking for this organization:

1. Join Discord: https://discord.gg/hjUhu33uAn
2. In Discord, run /link swastiksharma45
3. Paste the verification code into your GitHub bio (or a public gist)
4. Click Verify in Discord (or run /verify-link swastiksharma45)

Once linked, Gitcord can notify you about reviews, merges, and more.

— Posted by Gitcord

[coderabbitai]

• Fix comments: Fix CodeRabbit comments on this PR