From ffadc9a8f881fde774e92959baa2a5a4e2f87ac5 Mon Sep 17 00:00:00 2001
From: Victor Hugo Avelar Ossorio <deltatuts@gmail.com>
Date: Sat, 12 Oct 2024 13:43:18 +0000
Subject: [PATCH] update package docs

---
 .github/workflows/documentation-links.yml | 24 +++++++++++------------
 .lycheeignore                             |  1 -
 mollie/doc.go                             | 14 +++++--------
 3 files changed, 16 insertions(+), 23 deletions(-)
 delete mode 100644 .lycheeignore

diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml
index 4f849a86..dfcfba88 100644
--- a/.github/workflows/documentation-links.yml
+++ b/.github/workflows/documentation-links.yml
@@ -23,17 +23,15 @@ jobs:
       - name: Link Checker
         id: lychee
         uses: lycheeverse/lychee-action@7da8ec1fc4e01b5a12062ac6c589c10a4ce70d67
-        with:
-          args: --no-progress './**/*.md'
 
-      - name: Create Issue From File
-        if: env.lychee_exit_code != 0
-        uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
-        with:
-          title: Link Checker Report
-          content-filepath: ./lychee/out.md
-          labels: |
-            report
-            automated-issue
-            help-wanted
-          assignees: VictorAvelar
+      # - name: Create Issue From File
+      #   if: env.lychee_exit_code != 0
+      #   uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd
+      #   with:
+      #     title: Link Checker Report
+      #     content-filepath: ./lychee/out.md
+      #     labels: |
+      #       report
+      #       automated-issue
+      #       help-wanted
+      #     assignees: VictorAvelar
diff --git a/.lycheeignore b/.lycheeignore
deleted file mode 100644
index 638fe321..00000000
--- a/.lycheeignore
+++ /dev/null
@@ -1 +0,0 @@
-"^<https://api\.mollie\.com/v2$>"
diff --git a/mollie/doc.go b/mollie/doc.go
index 677e0706..5e85f8c2 100644
--- a/mollie/doc.go
+++ b/mollie/doc.go
@@ -1,13 +1,9 @@
 // Package mollie is a wrapper around Mollie's REST API.
 //
-// See: https://www.mollie.com/en/developers
+// See: https://www.mollie.com/developers
 //
-// The Mollie API implements a Representational state transfer (REST) architecture.
-//
-// Sounds technical, but it’s really quite easy. It mainly breaks down to HTTP-methods
-// GET, PATCH, POST and DELETE matching the operations to read, update, create and delete.
-//
-// REST also implies a nice and clean structure for URLs or endpoints.
-// This means you can reach any part of the Mollie API on https://api.mollie.com/v2/ adding
-// the name of the resource you want to interact with.
+// The Mollie API is a straightforward REST API. This means all endpoints
+// either create, retrieve, or update objects. API calls are authenticated
+// with an [API credential](https://docs.mollie.com/reference/authentication).
+// In some cases, you can receive live updates via [webhooks](https://docs.mollie.com/reference/webhooks).
 package mollie