docs: improve README with how-to guides and troubleshooting section #4691
Conversation
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
…shooting - Add gitflow installation guidance to address issue jesseduffield#2606 - Add 'How do I...' section with config editing instructions (part of jesseduffield#963) - Add troubleshooting section for common installation issues - Improve navigation with better table of contents structure - Add terminal compatibility notice for 'WARNING: terminal is not fully functional' issues
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.
Fixes #963, #2606, #3704
Added a FAQ section to help new users find common answers quickly. Also included troubleshooting for the terminal warning that keeps coming up in issues.
Let me know if you'd prefer these in separate PRs.