barrettruth/preview.nvim
1
0
Fork 0
Code Issues Pull requests Releases Packages Activity Actions

docs: add quick start and rename vimdoc #127

Merged
barrettruth merged 1 commit from docs/help-quickstart into main 2026-05-09 16:14:32 +00:00
Conversation 0 Commits 1 Files changed 5 +81 -18
barrettruth commented 2026-05-09 15:50:53 +00:00
Owner
Copy link

Checklist

  • I have read CONTRIBUTING.md.
  • No AI was used to generate, edit, or review any part of this contribution.

Problem

The README and vimdoc still centered the legacy preview.nvim help topic, and
the help file kept the .nvim suffix in its filename.

Solution

  • Rename the help file to doc/preview.txt while preserving legacy help tags.
  • Add a concise Quick Start to the README and vimdoc for the common preview loop.
  • Prefer :help preview and :help preview-migration in user-facing pointers.

Verification

  • git diff --check
  • vimdoc-language-server format --check doc/
  • vimdoc-language-server check doc/
  • stylua --check lua/preview/migration.lua spec/migration_spec.lua
  • nix develop --command env LUA_PATH='./lua/?.lua;./lua/?/init.lua;./spec/?.lua;;' busted spec/migration_spec.lua
## Checklist - [x] I have read [CONTRIBUTING.md](https://git.barrettruth.com/barrettruth/preview.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem The README and vimdoc still centered the legacy `preview.nvim` help topic, and the help file kept the `.nvim` suffix in its filename. ## Solution - Rename the help file to `doc/preview.txt` while preserving legacy help tags. - Add a concise Quick Start to the README and vimdoc for the common preview loop. - Prefer `:help preview` and `:help preview-migration` in user-facing pointers. ## Verification - [x] `git diff --check` - [x] `vimdoc-language-server format --check doc/` - [x] `vimdoc-language-server check doc/` - [x] `stylua --check lua/preview/migration.lua spec/migration_spec.lua` - [x] `nix develop --command env LUA_PATH='./lua/?.lua;./lua/?/init.lua;./spec/?.lua;;' busted spec/migration_spec.lua`
docs: add quick start and rename vimdoc
All checks were successful
quality / Format (pull_request) Successful in 10s
Details
quality / Test (pull_request) Successful in 6s
Details
quality / Lint (pull_request) Successful in 8s
Details
48c7d4f83a
barrettruth deleted branch docs/help-quickstart 2026-05-09 16:14:33 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
barrettruth/preview.nvim!127
No description provided.