doc: add a better description

davvid · Feb 20, 2024 · 8e47b73 · 8e47b73
1 parent d02c4ba
commit 8e47b73
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/.github/workflows/push.yaml b/.github/workflows/push.yaml
@@ -31,7 +31,7 @@ jobs:
       - name: Generate docs
         uses: kdheepak/panvimdoc@main
         with:
-          description: ' Fork of the harpoon.term module from Harpoon v1'
+          description: Quickly jump to terminals
           vimdoc: harpoon-term
           pandoc: README.md
           toc: 'false'

diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # harpoon-term
 
+Quickly jump to terminals.
+
 *Harpoon Term* is a friendly fork of the `harpoon.term` module from
 [harpoon](https://github.com/ThePrimeagent/harpoon).
 

diff --git a/doc/harpoon-term.txt b/doc/harpoon-term.txt
@@ -1,8 +1,10 @@
-*harpoon-term.txt*             Fork of the harpoon.term module from Harpoon v1
+*harpoon-term.txt*                                   Quickly jump to terminals
 
 ==============================================================================
 1. harpoon-term                                    *harpoon-term-harpoon-term*
 
+Quickly jump to terminals.
+
 _Harpoon Term_ is a friendly fork of the `harpoon.term` module from harpoon
 <https://github.com/ThePrimeagent/harpoon>.
 

diff --git a/garden.yaml b/garden.yaml
@@ -30,7 +30,7 @@ trees:
         - doc/post
       doc/build: |
         panvimdoc.sh \
-          --description ' Fork of the harpoon.term module from Harpoon v1' \
+          --description 'Quickly jump to terminals' \
           --input-file README.md \
           --project-name ${TREE_NAME} \
           --toc false