Fix: Add comprehensive troubleshooting guide for BI [docs-1.4.0]

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

• Issue: Create Troubleshooting Guide for BI #200
• Type: Documentation / Suggestions
• Summary: Added a comprehensive troubleshooting guide for WSO2 Integrator: BI covering installation, configuration, common issues, logs and debugging, reporting issues, and environment compatibility. Also fixed pre-existing navigation structure warning in the Debugging & Troubleshooting section.

New Document Verification: CONFIRM that this new document FULLY COMPLIES with ALL Microsoft Style Guide requirements. Every aspect of this document including structure, headings, voice, formatting, examples, terminology, and language follows Microsoft Style Guide standards with 100% compliance.

Image Verification: No images were added in this troubleshooting guide. All references to directories and file locations are textual.

Verification: mkdocs build --strict passed successfully.

Changes

• Created new troubleshooting guide at en/docs/references/troubleshooting.md
• Added troubleshooting guide to navigation in mkdocs.yml
• Fixed pre-existing navigation structure warning in mkdocs.yml (Debugging & Troubleshooting section)

Content Coverage

The troubleshooting guide includes:

1. Installation instructions and common installation errors
2. Key artifacts and file locations (.ballerina, cache, logs)
3. Logs and debugging guidance
4. Configuration instructions for BI
5. Common issues and fixes (startup failures, cache corruption, connection issues, etc.)
6. Issue reporting guidelines
7. Environment and compatibility verification

All content follows Microsoft Style Guide with active voice, present tense, sentence case headings, and proper formatting.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fbba5430-2b60-4a15-b19b-d7c8927b6c7c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fixing-issue-200-1772793309

---

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

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