Skip to content

docs: add troubleshooting guide for C# helper, WASAPI and IPC issues#125

Merged
SamXop123 merged 1 commit into
SamXop123:mainfrom
YAXH64:YAXH64-add-troubleshooting-docs
May 30, 2026
Merged

docs: add troubleshooting guide for C# helper, WASAPI and IPC issues#125
SamXop123 merged 1 commit into
SamXop123:mainfrom
YAXH64:YAXH64-add-troubleshooting-docs

Conversation

@YAXH64
Copy link
Copy Markdown
Contributor

@YAXH64 YAXH64 commented May 29, 2026

Summary

Adds a troubleshooting guide to help contributors resolve common setup and runtime issues.

Changes

  • Added C# compilation troubleshooting
  • Added WASAPI loopback configuration guide
  • Added helper process crash troubleshooting
  • Added IPC/audio bridge debugging steps
  • Added platform-specific notes
  • Added quick diagnostic checklist

Closes #

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive troubleshooting guide to help users resolve common setup and runtime issues throughout the application. It addresses audio capture configuration, helper process failures, inter-process communication errors, and expected behavior on different platforms. The guide provides detailed solutions, step-by-step diagnostic procedures, and a quick reference checklist for efficient troubleshooting.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 29, 2026

@YAXH64 is attempting to deploy a commit to the Dot_NotSam's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

📝 Walkthrough

Walkthrough

This PR adds a comprehensive troubleshooting guide to docs/TROUBLESHOOTING.md, providing diagnostic and resolution steps for common issues in the Paraline audio capture pipeline across .NET SDK setup, WASAPI device configuration, helper process execution, IPC communication, and platform-specific behavior.

Changes

Troubleshooting Documentation

Layer / File(s) Summary
Guide introduction and C# build troubleshooting
docs/TROUBLESHOOTING.md
Introduces the troubleshooting scope with an overview list, then documents .NET SDK verification, audio helper compilation/restore, MSBuild/workload fixes, and clean rebuild procedures.
WASAPI, helper process, and IPC runtime issues
docs/TROUBLESHOOTING.md
Covers WASAPI default device checks, audio-level diagnostics, Bluetooth-specific behavior, helper binary discovery, antivirus/permission issues, manual execution with JSON output examples, the helper↔Electron JSON/stdout bridge contract, invalid JSON handling, process crash recovery, and simulated-audio behavior on unsupported platforms.
Diagnostic checklist and documentation links
docs/TROUBLESHOOTING.md
Provides a quick diagnostic workflow checklist and links to development setup and architecture documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

  • #92: Directly related; both target the same docs/TROUBLESHOOTING.md guide for C# WASAPI helper and IPC/helper process troubleshooting.

Poem

🐰 A guide for the weary, when audio won't play,
From build to WASAPI, we show you the way.
When processes crash and JSON arrays fail,
Through checklist and steps, may your troubleshoots prevail! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately summarizes the main change: adding documentation for troubleshooting C# helper compilation, WASAPI issues, and IPC problems—all of which are confirmed in the raw summary and objectives.
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.

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@docs/TROUBLESHOOTING.md`:
- Around line 148-150: The two fenced code blocks containing the paths
"audio-helper\bin\Debug\net8.0-windows\Paraline.AudioBridge.exe" and
"build\audio-helper\Paraline.AudioBridge.exe" are missing language identifiers
and trigger MD040; update each triple-backtick fence to include a language tag
(e.g., use `text`) so they become ```text ... ``` to satisfy the linter and keep
the docs lint-clean.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b190fe5-9955-4b2c-9262-b33926270c21

📥 Commits

Reviewing files that changed from the base of the PR and between 7e6a9e1 and ce9dfd8.

📒 Files selected for processing (1)
  • docs/TROUBLESHOOTING.md

Comment thread docs/TROUBLESHOOTING.md
Comment on lines +148 to +150
```
audio-helper\bin\Debug\net8.0-windows\Paraline.AudioBridge.exe
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language identifiers to fenced code blocks.

These two fences are missing a language tag and trigger MD040. Please annotate them (for example, use text) to keep docs lint-clean.

Suggested diff
-```
+```text
 audio-helper\bin\Debug\net8.0-windows\Paraline.AudioBridge.exe

@@
- +text
build\audio-helper\Paraline.AudioBridge.exe

Also applies to: 154-156

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 148-148: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 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 `@docs/TROUBLESHOOTING.md` around lines 148 - 150, The two fenced code blocks
containing the paths
"audio-helper\bin\Debug\net8.0-windows\Paraline.AudioBridge.exe" and
"build\audio-helper\Paraline.AudioBridge.exe" are missing language identifiers
and trigger MD040; update each triple-backtick fence to include a language tag
(e.g., use `text`) so they become ```text ... ``` to satisfy the linter and keep
the docs lint-clean.

Copy link
Copy Markdown
Owner

@SamXop123 SamXop123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

@SamXop123 SamXop123 added documentation Improvements or additions to documentation gssoc26 GirlScript Summer of Code 2026 gssoc:approved level:beginner type:docs quality:exceptional labels May 30, 2026
@SamXop123
Copy link
Copy Markdown
Owner

Closes #92

@SamXop123 SamXop123 merged commit 9346b05 into SamXop123:main May 30, 2026
1 of 2 checks passed
@github-actions
Copy link
Copy Markdown

🎉 Congratulations @YAXH64! 🎉

Your pull request has been successfully merged into Paraline! Thank you so much for your valuable contribution and effort. Every single improvement helps make Paraline a better desktop experience for everyone! 🙌

🚀 What's Next?

  • Keep the momentum going! Feel free to browse through our open Issues and grab another one that interests you!
  • Support the Project: If you enjoyed contributing to Paraline, please take a second to star our repository! It helps increase the project's visibility and supports our community. ⭐

💬 Stay Connected:
Have any questions, want feedback, or just want to discuss further contributions? Feel free to reach out directly to the maintainer on Discord: dot_notsam!

Thank you again, and keep up the amazing work! 💻✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation gssoc:approved gssoc26 GirlScript Summer of Code 2026 level:beginner quality:exceptional type:docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants