fix: make doc gen CI work in pull requests (#28)

* fix: make doc gen CI work in pull requests

* trim

* chore: ci fix

* chore: auto-generate vimdoc via panvimdoc

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.github/workflows/panvimdoc.yml

@@ -1,19 +1,26 @@
-name: Auto-generate Vimdoc using Pandoc
+name: Auto-generate Vimdoc using Pandoc in CI
 
 on:
-  push:
+  pull_request:
     branches: ["main"]
+    paths:
+      - README.md
+      - .github/**
 
+# Set permissions of the GITHUB_TOKEN to allow modifications to files
+permissions:
+  contents: write
+
+# Allow one concurrent deployment
 concurrency:
   group: ${{github.workflow}}-${{github.ref}}
   cancel-in-progress: false
 
 jobs:
-  custom_test:
+  docs:
     runs-on: ubuntu-latest
-    name: pandoc to vimdoc
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Generate docs
         uses: kdheepak/panvimdoc@main

README.md

@@ -36,7 +36,7 @@ Assuming you don't have any configuration in the `.vimrc` file, it's nicer to se
 Steps:
 1. Get yourself a Vim of version 8+ installed and make sure to have git installed and present on your path as well
 2. Create a `~/.vimrc` file (or `~/_vimrc` if you're on Windows)
-3. Without such file there were sourced defaults by the Vim authors, but once it's created, we have to put them back explicitly by adding those lines in and saving changes <kbd>:w</kbd>: 
+3. Without such file there were sourced defaults by the Vim authors, but once it's created, we have to put them back explicitly by adding those lines in and saving changes <kbd>:w</kbd>:
 
 ```vim
 unlet! skip_defaults_vim