[setchy]

Summary

Defines the TSDoc convention the project wants proposals and changes to follow, and aligns the preload/IPC contract docs with it. This covers tsdoc-01-contract-accuracy (tasks 1.1-1.5) plus the contributor documentation task 5.4.

• Add a TSDoc section to CONTRIBUTING.md covering summaries, @param, @returns, named result types, @throws, @remarks, @example, @typeParam, and the rule that lint findings are fixed rather than suppressed.
• Describe decryptValue as returning the decrypted token, plus the optional re-encrypted ciphertext to persist.
• Describe the GitHub CLI token result by its success and classified-failure branches in the preload, renderer, and main-process layers.
• Describe getAppVersion as v<semver> for packaged builds and dev in development.
• Rename the sendRendererEvent payload documentation from data to the variadic args.
• Add the missing @param tags for window vibrancy, native theme, and tray appearance.

The return docs deliberately describe meaning and branches rather than restating object shapes. The named result types remain the single source of truth for exact fields.

Scope

Documentation only; no runtime, IPC contract, or UI behavior changes.

Verification

• pnpm check
• pnpm test src/preload/index.test.ts src/renderer/utils/system/comms.test.ts src/main/events.test.ts (37 tests passed)

[sonarqubecloud]

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 SonarQube Cloud