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

docs: add quick start and rename vimdoc #43

Merged
barrettruth merged 1 commit from docs/help-quickstart into main 2026-05-09 16:28:31 +00:00
Conversation 0 Commits 1 Files changed 4 +53 -10
barrettruth commented 2026-05-09 15:57:51 +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 migration warning still pointed users at legacy .nvim help topics, and the vimdoc file used the legacy filename.

Solution

  • Rename the vimdoc file to doc/import-cost.txt while preserving legacy help tags.
  • Keep Installation separate from Quick Start, with both vim.pack and LuaRocks install paths intact.
  • Add a concise Quick Start for post-install use: supported buffers attach automatically and vim.g.import_cost customizes behavior.
  • Update README, CONTRIBUTING, and the migration warning to prefer the clean help topics.

Verification

  • git diff --check
  • vimdoc-language-server check doc/
  • vimdoc-language-server format --check doc/
  • stylua --check lua/import-cost/migration.lua
  • just lint
## Checklist - [x] I have read [CONTRIBUTING.md](https://git.barrettruth.com/barrettruth/import-cost.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem The README and migration warning still pointed users at legacy `.nvim` help topics, and the vimdoc file used the legacy filename. ## Solution - Rename the vimdoc file to `doc/import-cost.txt` while preserving legacy help tags. - Keep Installation separate from Quick Start, with both `vim.pack` and LuaRocks install paths intact. - Add a concise Quick Start for post-install use: supported buffers attach automatically and `vim.g.import_cost` customizes behavior. - Update README, CONTRIBUTING, and the migration warning to prefer the clean help topics. ## Verification - `git diff --check` - `vimdoc-language-server check doc/` - `vimdoc-language-server format --check doc/` - `stylua --check lua/import-cost/migration.lua` - `just lint`
docs: add quick start and rename vimdoc
Some checks are pending
quality / Format (pull_request) Waiting to run
Details
quality / Lint (pull_request) Waiting to run
Details
b7c8939add
barrettruth force-pushed docs/help-quickstart from b7c8939add
Some checks are pending
quality / Format (pull_request) Waiting to run
Details
quality / Lint (pull_request) Waiting to run
Details
to 68defa393c
All checks were successful
quality / Format (pull_request) Successful in 9s
Details
quality / Lint (pull_request) Successful in 6s
Details
2026-05-09 16:16:53 +00:00 Compare
barrettruth deleted branch docs/help-quickstart 2026-05-09 16:28:31 +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/import-cost.nvim!43
No description provided.