Polish README quick start before wider announcement #666

New issue

Closed

opened 2026-05-09 00:46:57 +00:00 by barrettruth · 0 comments

barrettruth commented

2026-05-09 00:46:57 +00:00

Owner

Problem

The plugin is feature-complete enough for a preview, but the README is still sparse as a first landing page. It lists features and install steps, then mostly punts users to :help forge.nvim.

Current gaps from the preview audit:

no short first-run path like :checkhealth forge, :Forge pr, :Forge ci, or :lua require("forge").open();
feature bullets mention PRs, issues, CI, browse/yank, but omit releases even though release workflows are implemented and documented;
no recommended keymap for the root workflow picker, while bare :Forge intentionally warns missing command.

Expected

Add a tiny quick-start/readme polish pass that helps a new user reach the main workflows without reading the full vimdoc first.

Non-goals

Do not rewrite the README into marketing copy; keep it concise and consistent with the vimdoc.

## Problem The plugin is feature-complete enough for a preview, but the README is still sparse as a first landing page. It lists features and install steps, then mostly punts users to `:help forge.nvim`. Current gaps from the preview audit: - no short first-run path like `:checkhealth forge`, `:Forge pr`, `:Forge ci`, or `:lua require("forge").open()`; - feature bullets mention PRs, issues, CI, browse/yank, but omit releases even though release workflows are implemented and documented; - no recommended keymap for the root workflow picker, while bare `:Forge` intentionally warns `missing command`. ## Expected Add a tiny quick-start/readme polish pass that helps a new user reach the main workflows without reading the full vimdoc first. ## Non-goals Do not rewrite the README into marketing copy; keep it concise and consistent with the vimdoc.

barrettruth added the

enhancement

label

2026-05-09 00:46:57 +00:00

barrettruth referenced this issue

2026-05-09 00:47:16 +00:00

Tracker: release-preview readiness follow-up #667

barrettruth referenced this issue from a pull request that will close it,

2026-05-09 00:58:02 +00:00

docs: add README quick start #673

barrettruth closed this issue

2026-05-09 02:39:17 +00:00