docs: reorganise README, move sections to RECIPES.md and TIPS.md#32
Merged
dlyongemallo merged 1 commit intomainfrom Mar 9, 2026
Merged
docs: reorganise README, move sections to RECIPES.md and TIPS.md#32dlyongemallo merged 1 commit intomainfrom
dlyongemallo merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Reorganizes the project documentation by trimming and restructuring the README and moving longer “how-to” content into dedicated markdown files for recipes and troubleshooting, making the main README more scannable.
Changes:
- Added RECIPES.md with keymap/configuration snippets for common workflows.
- Added TIPS.md with FAQ, revision-argument guidance, platform notes, and compatibility workarounds.
- Updated README.md to include a Quick Start, concise feature/command summary, and links to the new docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Streamlines README into an overview + entry points to detailed docs. |
| RECIPES.md | Introduces copy-pasteable recipes for keymaps, configs, and integrations. |
| TIPS.md | Collects FAQ, practical tips, and known compatibility issues/workarounds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.