docs: add quick start and rename vimdoc #684

Merged

barrettruth merged 1 commit from docs/help-quickstart into main

2026-05-09 15:43:05 +00:00

barrettruth commented

2026-05-09 15:36:53 +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 points readers directly from installation to release notes, so the first real workflow is only discoverable from the full vimdoc. The vimdoc filename also uses the repository suffix as its primary name, and the contents table needed updated dot leaders after the help tags changed.

Solution

Add a short story-style Quick Start after installation, rename the vimdoc to doc/forge.txt while keeping compatibility tags for forge.nvim, update :help references to the cleaner forge and forge-forgejo tags, and align the vimdoc contents table to 78 columns.

## Checklist - [x] I have read [CONTRIBUTING.md](https://git.barrettruth.com/barrettruth/forge.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem The README points readers directly from installation to release notes, so the first real workflow is only discoverable from the full vimdoc. The vimdoc filename also uses the repository suffix as its primary name, and the contents table needed updated dot leaders after the help tags changed. ## Solution Add a short story-style Quick Start after installation, rename the vimdoc to `doc/forge.txt` while keeping compatibility tags for `forge.nvim`, update `:help` references to the cleaner `forge` and `forge-forgejo` tags, and align the vimdoc contents table to 78 columns.

barrettruth added 1 commit

2026-05-09 15:36:53 +00:00

docs: add forge quick start

quality / Format (pull_request) Waiting to run

Details

quality / Lint (pull_request) Waiting to run

Details

quality / Test (pull_request) Waiting to run

Details

782e7a1e59