barrettruth/live-server.nvim
1
0
Fork 0
Code Issues Pull requests Releases Packages Activity Actions

docs: add quick start and rename vimdoc #55

Merged
barrettruth merged 1 commit from docs/help-quickstart into main 2026-05-09 16:12:56 +00:00
Conversation 0 Commits 1 Files changed 4 +80 -17
barrettruth commented 2026-05-09 16:01:44 +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

  • Vimdoc still used the .nvim filename/topic as the primary help entry.
  • README had no compact workflow-oriented Quick Start.

Solution

  • Rename doc/live-server.nvim.txt to doc/live-server.txt while preserving legacy help tags.
  • Add clean :help live-server and :help live-server-migration pointers.
  • Add a short Quick Start in README and vimdoc around config, start, toggle, and stop.

Verification

  • git diff --check
  • vimdoc-language-server format --check doc/
  • vimdoc-language-server check doc/
  • nix develop --command just ci
## Checklist - [x] I have read [CONTRIBUTING.md](https://git.barrettruth.com/barrettruth/live-server.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem - Vimdoc still used the `.nvim` filename/topic as the primary help entry. - README had no compact workflow-oriented Quick Start. ## Solution - Rename `doc/live-server.nvim.txt` to `doc/live-server.txt` while preserving legacy help tags. - Add clean `:help live-server` and `:help live-server-migration` pointers. - Add a short Quick Start in README and vimdoc around config, start, toggle, and stop. ## Verification - `git diff --check` - `vimdoc-language-server format --check doc/` - `vimdoc-language-server check doc/` - `nix develop --command just ci`
docs: add quick start and rename vimdoc
All checks were successful
quality / Format (pull_request) Successful in 9s
Details
quality / Lint (pull_request) Successful in 7s
Details
9c970d9050
barrettruth deleted branch docs/help-quickstart 2026-05-09 16:12:56 +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/live-server.nvim!55
No description provided.