docs: add vimdoc pointer to README #56

Merged

barrettruth merged 1 commit from docs/readme-documentation into main

2026-05-09 15:30:21 +00:00

barrettruth commented

2026-05-09 15:24:56 +00:00

Owner

Checklist

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

Problem

The README explains installation and colorscheme setup, but does not point readers to the vimdoc before listing integrations. The vimdoc file also used the repository suffix as its primary filename.

Solution

Rename the help file to doc/midnight.txt, keep compatibility tags for midnight.nvim, move the midnight help tag to the introduction, and add a short README Documentation section with :help midnight.

## Checklist - [x] I have read [CONTRIBUTING.md](https://git.barrettruth.com/barrettruth/midnight.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem The README explains installation and colorscheme setup, but does not point readers to the vimdoc before listing integrations. The vimdoc file also used the repository suffix as its primary filename. ## Solution Rename the help file to `doc/midnight.txt`, keep compatibility tags for `midnight.nvim`, move the `midnight` help tag to the introduction, and add a short README Documentation section with `:help midnight`.

barrettruth added 1 commit

2026-05-09 15:24:56 +00:00

docs: add vimdoc pointer

quality / Format (pull_request) Waiting to run

Details

quality / Lint (pull_request) Waiting to run

Details

f24b429e00