Skip to content

docs: restructure README for clarity - #2

Merged
wassimk merged 1 commit into
mainfrom
wm/readme-clarity
Feb 21, 2026
Merged

wassimk merged 1 commit into
mainfrom
wm/readme-clarity

Conversation

@wassimk

@wassimk wassimk commented Feb 21, 2026

Copy link
Copy Markdown
Owner

Summary

  • Break Usage into two clear steps: "Define Your Handles" and "Use in a Commit"
  • Add a concrete commit message example showing the end result
  • Demote Snippet details under Configuration (not a primary workflow step)
  • Add section emojis matching gh-navigator.nvim style (📋, 🛠️, 💻, 🔧, 🔨)
  • Link to GitHub docs on co-authored commits
  • Add placeholder comment for future demo video

Test plan

  • Verify vimdoc regenerated correctly
  • Review rendered README on GitHub for formatting

Break the Usage section into Step 1 (Define Your Handles) and Step 2
(Use in a Commit) to make the workflow easier to follow. Add a concrete
commit message example showing the end result. Demote the Snippet section
under Configuration since it's a detail, not a primary workflow step.
Add section emojis matching gh-navigator.nvim style. Link to the GitHub
docs on co-authored commits.
@wassimk
wassimk merged commit f2cab0a into main Feb 21, 2026
2 checks passed
@wassimk
wassimk deleted the wm/readme-clarity branch February 21, 2026 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant