ci: disable readme-sync action

Author: boltlessengineer

.github/workflows/ci.yml

@@ -10,30 +10,31 @@ permissions:
   contents: write
   pull-requests: write
 
+# TODO: this conflicts with format.yml
 jobs:
-  sync-readme:
-    name: sync readme codes
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v4
-      - name: run substitution
-        run: |
-          vimcmd="/default-config:start/+1,/default-config:end/-1y a |\
-          e README.md |\
-          /default-config:start/+2,/default-config:end/-2d |\
-          /default-config:start/+1put a |\
-          wq"; vim lua/rest-nvim/config/default.lua -c "$vimcmd"
-      - name: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: "docs: update README default config section"
-          branch: ${{ github.ref }}
+  # sync-readme:
+  #   name: sync readme codes
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 5
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - name: run substitution
+  #       run: |
+  #         vimcmd="/default-config:start/+1,/default-config:end/-1y a |\
+  #         e README.md |\
+  #         /default-config:start/+2,/default-config:end/-2d |\
+  #         /default-config:start/+1put a |\
+  #         wq"; vim lua/rest-nvim/config/default.lua -c "$vimcmd"
+  #     - name: Commit changes
+  #       uses: stefanzweifel/git-auto-commit-action@v5
+  #       with:
+  #         commit_message: "docs: update README default config section"
+  #         branch: ${{ github.ref }}
 
   release:
     name: release
     runs-on: ubuntu-latest
-    needs: [sync-readme]
+    # needs: [sync-readme]
     steps:
       - uses: googleapis/release-please-action@v4
         with:

README.md

@@ -136,10 +136,10 @@ local default_config = {
         curl = {
             ---Statistics to be shown, takes cURL's `--write-out` flag variables
             ---See `man curl` for `--write-out` flag
-            ---@type table<string,RestStatisticsStyle>
+            ---@type RestStatisticsStyle[]
             statistics = {
-                time_total = { winbar = "take", title = "Time taken" },
-                size_download = { winbar = "size", title = "Download size" },
+                { id = "time_total", winbar = "take", title = "Time taken" },
+                { id = "size_download", winbar = "size", title = "Download size" },
             },
         },
     },