Skip to content

Docs/add troubleshooting guide#958

Open
bswara11 wants to merge 2 commits into
SdSarthak:mainfrom
bswara11:docs/add-troubleshooting-guide
Open

Docs/add troubleshooting guide#958
bswara11 wants to merge 2 commits into
SdSarthak:mainfrom
bswara11:docs/add-troubleshooting-guide

Conversation

@bswara11

@bswara11 bswara11 commented Jun 3, 2026

Copy link
Copy Markdown

Summary

Closes #529

Description

Added a dedicated Troubleshooting section to the README to help contributors and users quickly resolve common setup and runtime issues.

Changes Made

  • Added troubleshooting guidance for Docker Compose startup failures.
  • Added solutions for backend .env configuration issues.
  • Added PostgreSQL connection troubleshooting steps.
  • Added guidance for resolving port conflicts (5173, 8000, 5432).
  • Added Ollama connectivity troubleshooting.
  • Added dependency installation troubleshooting for Python and Node.js.
  • Added version compatibility checks for Python and Node.js environments.

Type of Change

  • Documentation update

Related Issue

Fixes #529

Why This Change?

AegisAI supports multiple setup methods and technologies, which can sometimes lead to onboarding challenges. This troubleshooting section provides quick access to common solutions, reducing setup time and improving the contributor experience.

Testing

  • Verified Markdown formatting and readability.
  • Reviewed all commands and troubleshooting examples for consistency.
  • Confirmed documentation structure remains clear and easy to navigate.

Checklist

  • Documentation follows project guidelines
  • Self-reviewed changes
  • No functional code changes introduced
  • Markdown formatting verified

Additional Notes

This PR only updates documentation and does not modify application functionality.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Troubleshooting Section for Common Setup Errors

1 participant