docs: add detailed offline-friendly feature descriptions#5437
Open
xingzihai wants to merge 1 commit intojesseduffield:masterfrom
Open
docs: add detailed offline-friendly feature descriptions#5437xingzihai wants to merge 1 commit intojesseduffield:masterfrom
xingzihai wants to merge 1 commit intojesseduffield:masterfrom
Conversation
Issue: jesseduffield#5428 - README.MD not a real help offline The README.md's demo GIFs use relative paths (../assets/) which don't work when viewing the file offline (e.g., from a downloaded release zip). The assets are stored on a separate branch and are not included in releases. This fix adds: - A note at the top of Features section directing users to GitHub for animated demos (best online experience) - Detailed step-by-step "How it works" instructions for each feature section that work offline without images - Additional context like "Quick actions", "Use cases", "Benefits" etc. This makes the README useful offline while maintaining the animated demo experience for online viewers.
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
1 participant
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.
This PR adds detailed offline-friendly feature descriptions to the README, helping users understand features when offline.\n\n## Changes\n- Added comprehensive feature descriptions\n- Improved offline documentation\n\nFixes #5428