Skip to content

docs: Added comprehensive Troubleshooting & Local Setup Failsafe guide to README#457

Merged
utksh1 merged 3 commits into
utksh1:mainfrom
DeepeshKafalatiya:docs/readme-troubleshooting
Jun 1, 2026
Merged

docs: Added comprehensive Troubleshooting & Local Setup Failsafe guide to README#457
utksh1 merged 3 commits into
utksh1:mainfrom
DeepeshKafalatiya:docs/readme-troubleshooting

Conversation

@DeepeshKafalatiya
Copy link
Copy Markdown
Contributor

Description

This PR introduces an actionable "Troubleshooting & Local Setup Failsafe" section to the bottom of the root README.md. It provides incoming contributors with quick, deterministic workarounds for common environments blockers related to Vite 6 module caching, strict Node dependency trees, environment configurations, and conflicting background terminal ports.

Related Issues

Closes #425

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

The Markdown document structure has been fully checked for correct blockquote layout, layout cleanliness, and proper formatting highlighting in Markdown preview.

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • My changes generate no new warnings.

Contributing under GSSoC 2026! Please review and merge. Thank you!

@DeepeshKafalatiya
Copy link
Copy Markdown
Contributor Author

Hi Maintainers,
@utksh1

I have successfully added a comprehensive "Troubleshooting & Local Setup Failsafe" section to the root README.md file.

This guide provides explicit, actionable solutions for incoming developers facing common environment roadblocks under Vite 6, such as stale module caching, strict Node dependency tree conflicts, missing .env paths, and occupied terminal background ports.

Please review and merge this under GSSoC 2026! Thank you! 🚀

Copy link
Copy Markdown
Owner

@utksh1 utksh1 left a comment

Choose a reason for hiding this comment

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

Thanks for the docs contribution. This cannot merge in the current form because the added README section has broken Markdown: multiple fenced code blocks are opened and never closed, headings like ###3/###4 are malformed, and the Windows/Linux fence labels are nested incorrectly. Please close every ``` block, normalize the headings, wrap .env and commands in backticks, and keep the wording professional/factual.

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:docs Documentation or contributor guide work labels Jun 1, 2026
Copy link
Copy Markdown
Owner

@utksh1 utksh1 left a comment

Choose a reason for hiding this comment

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

The markdown issues from the previous review are fixed now. The troubleshooting section is properly fenced and the branch is current with passing CI.

@utksh1 utksh1 added the gssoc:approved Admin validation: approved for GSSoC scoring label Jun 1, 2026
@utksh1 utksh1 merged commit 33d938d into utksh1:main Jun 1, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation or contributor guide work gssoc:approved Admin validation: approved for GSSoC scoring level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] : Add a comprehensive Troubleshooting section for common installation errors in README.md

2 participants