Enhance README with troubleshooting and FAQ - #2473
Open
Dippp10-ally wants to merge 1 commit into
Open
Conversation
Added troubleshooting and FAQ sections to README.
Contributor
Author
|
@utksh1 ji , do assign labels called as gssoc:approved, level:intermediate, type:docs, quality:exceptional to above pull request number 2473 also.....do merge above pull request number 2473 also.... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Added Troubleshooting and FAQ sections to the README to help users resolve common issues and quickly find answers to frequently asked questions.
Related Issues
Fixes #2472
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?
Reviewed the updated README locally to verify that the Troubleshooting and FAQ sections are correctly formatted, clear, and easy to navigate.
Checklist
My code follows the code style of this project.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.