Skip to content

Enhance README with troubleshooting and FAQ - #351

Open
Dippp10-ally wants to merge 1 commit into
pushkarscripts:mainfrom
Dippp10-ally:patch-2
Open

Enhance README with troubleshooting and FAQ#351
Dippp10-ally wants to merge 1 commit into
pushkarscripts:mainfrom
Dippp10-ally:patch-2

Conversation

@Dippp10-ally

Copy link
Copy Markdown

Related Issue

Fixes #350


Description

This PR enhances the project documentation by adding dedicated Troubleshooting and FAQ sections to the README.

Changes Made

  • Added a Troubleshooting Guide covering common installation, configuration, and runtime issues.
  • Added a Frequently Asked Questions (FAQ) section addressing common user and contributor queries.
  • Improved documentation structure and readability for easier navigation.
  • Included practical solutions and guidance to streamline onboarding and reduce repetitive support requests.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • UI/UX improvement
  • Refactor

Screenshots / Demo

N/A – Documentation-only changes.


How Has This Been Tested?

  • Reviewed the README formatting in Markdown preview.
  • Verified that all headings, lists, and links render correctly.
  • Confirmed the newly added sections are easy to navigate and readable.

Checklist

  • My code follows the project structure and conventions
  • I have tested the changes locally
  • I have linked the related issue properly
  • I have added screenshots where applicable (Not applicable)
  • No existing functionality was broken

AI Usage

  • I have not used AI tools for this contribution

  • I have used AI tools (ChatGPT, Copilot, Claude, etc.) and I have reviewed, verified, and understood all generated code/content before submitting this PR

If AI tools were used, briefly explain how:

AI was used to help draft and refine the Troubleshooting Guide, FAQ content, and PR description. All generated content was reviewed, edited, and verified before submission.


Additional Notes

This is a documentation-only improvement and does not modify the project's functionality. The Troubleshooting and FAQ sections can be expanded in future releases as new issues and common questions are identified.

Added troubleshooting and FAQ sections to README.
@vercel

vercel Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

@Dippp10-ally is attempting to deploy a commit to the PushkarScripts Team on Vercel.

A member of the Team first needs to authorize it.

@Dippp10-ally

Copy link
Copy Markdown
Author

@pushkarscripts ji , do assign labels called as gssoc:approved , level:intermediate , type:docs , quality:exceptional to above pull request number 351 also......do merge above pull request number 351 also.....

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.

[FEATURE] : Add Troubleshooting Guide and FAQ to Documentation

1 participant