Skip to content

docs: add comprehensive TROUBLESHOOT.md for common setup and development issues - #559

Open
durdana3105 wants to merge 2 commits into
AnuranjanJain:mainfrom
durdana3105:add-file
Open

docs: add comprehensive TROUBLESHOOT.md for common setup and development issues#559
durdana3105 wants to merge 2 commits into
AnuranjanJain:mainfrom
durdana3105:add-file

Conversation

@durdana3105

Copy link
Copy Markdown
Contributor

Summary

Closes #

This PR adds a comprehensive TROUBLESHOOT.md to help contributors and users quickly resolve common setup, configuration, and runtime issues while working with LegalEase.

Changes Made

  • Added a dedicated TROUBLESHOOT.md document.
  • Included troubleshooting steps for frontend (React + Vite) setup and development.
  • Added backend (FastAPI) installation and startup troubleshooting.
  • Documented environment variable configuration and common misconfigurations.
  • Included AI service and API key troubleshooting.
  • Added authentication and JWT-related troubleshooting.
  • Documented database and Supabase connection issues.
  • Added file upload and PDF export troubleshooting.
  • Included frontend and backend testing guidance.
  • Added Docker, build, CORS, rate-limiting, and port conflict troubleshooting.
  • Included a Frequently Asked Questions (FAQ) section and general debugging checklist.

Benefits

  • Simplifies project setup for new contributors.
  • Reduces repetitive support requests related to installation and configuration.
  • Provides a centralized reference for common development and runtime issues.
  • Improves the overall documentation and contributor experience.

Testing

  • Verified that all commands match the current project structure and README.
  • Reviewed troubleshooting steps for accuracy and consistency.
  • Documentation-only change; no application functionality was modified.

@vercel

vercel Bot commented Jul 19, 2026

Copy link
Copy Markdown

@durdana3105 is attempting to deploy a commit to the WizardKing's projects Team on Vercel.

A member of the Team first needs to authorize it.

@AnuranjanJain AnuranjanJain added GSSoC'26 gssoc:approved Approved for GSSOC contribution labels Jul 20, 2026
@AnuranjanJain

AnuranjanJain commented Jul 20, 2026

Copy link
Copy Markdown
Owner

@durdana3105 Which issue does it closes? Please mention it

@vercel

vercel Bot commented Jul 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
legal-ease Ready Ready Preview, Comment Jul 20, 2026 11:02am

@github-actions

Copy link
Copy Markdown

This PR has been inactive for 7 days. Please update the PR to keep it open. It will be closed in 3 days if there is no further activity.

@github-actions github-actions Bot added the stale label Jul 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved Approved for GSSOC contribution GSSoC'26 stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants