docs: add usage-focused vimdoc #162
Merged
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
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.
Overview
This PR adds a usage-focused vimdoc to provide built-in help documentation for codediff.nvim users. After this change, users can access help directly from Neovim using
:help codediff.What Changed
doc/codediff.txt): A comprehensive help file covering commands, usage modes, configuration options, highlight groups, and the Lua APIdoc/tags): Generated tags file enabling:helpnavigationWhy This Matters
Previously, users had to leave Neovim and consult README.md for usage information. Now they can quickly discover available commands and options using the native
:helpsystem, which is the expected Neovim user experience.The documentation is intentionally usage-focused—installation and development details remain in README.md to keep the help file concise and practical.
Testing
Documentation-only change; no functional code modified.