v3: Add support for consistent documentation using markdownlint (#3064)

* Add support for consistent documentation using markdownlint * Only run workflow during changes to markdown files * Fix more inconsistencies * Fixes to markdown under .github/ * More fixes * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Fix typo in limiter docs * Add missing space before code-block * Add check for dead-links * Add write-good * Remove legacy README files * Fix glob for skipping .md files * Use paths-ignore instead --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
gofiber · Jul 11, 2024 · 9463a8f · 9463a8f
1 parent c579a1a
commit 9463a8f
Show file tree

Hide file tree

Showing 72 changed files with 2,017 additions and 1,905 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -71,11 +71,11 @@ Community leaders will follow these Community Impact Guidelines in determining t
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -5,9 +5,11 @@ Before making any changes to this repository, we kindly request you to initiate
 Please note: we have a [code of conduct](https://github.com/gofiber/fiber/blob/master/.github/CODE_OF_CONDUCT.md), please follow it in all your interactions with the `Fiber` project.
 
 ## Pull Requests or Commits
+
 Titles always we must use prefix according to below:
 
 > 🔥 Feature, ♻️ Refactor, 🩹 Fix, 🚨 Test, 📚 Doc, 🎨 Style
+
 - 🔥 Feature: Add flow to add person
 - ♻️ Refactor: Rename file X to Y
 - 🩹 Fix: Improve flow
@@ -17,7 +19,7 @@ Titles always we must use prefix according to below:
 
 All pull requests that contain a feature or fix are mandatory to have unit tests. Your PR is only to be merged if you respect this flow.
 
-# 👍 Contribute
+## 👍 Contribute
 
 If you want to say **thank you** and/or support the active development of `Fiber`:
 

diff --git a/.github/README.md b/.github/README.md
@@ -1,4 +1,4 @@
-<p align="center">
+<h1 align="center">
   <a href="https://gofiber.io">
     <picture>
       <source height="125" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gofiber/docs/master/static/img/logo-dark.svg">
@@ -12,7 +12,7 @@
   <a href="https://goreportcard.com/report/github.com/gofiber/fiber/v3">
     <img src="https://img.shields.io/badge/%F0%9F%93%9D%20goreport-A%2B-75C46B?style=flat-square">
   </a>
-  <a href="https://codecov.io/gh/gofiber/fiber" > 
+  <a href="https://codecov.io/gh/gofiber/fiber" >
    <img alt="Codecov" src="https://img.shields.io/codecov/c/github/gofiber/fiber?token=3Cr92CwaPQ&style=flat-square&logo=codecov&label=codecov">
  </a>
   <a href="https://github.com/gofiber/fiber/actions?query=workflow%3ATest">
@@ -24,7 +24,7 @@
   <a href="https://gofiber.io/discord">
     <img src="https://img.shields.io/discord/704680098577514527?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
   </a>
-</p>
+</h1>
 <p align="center">
   <em><b>Fiber</b> is an <a href="https://github.com/expressjs/express">Express</a> inspired <b>web framework</b> built on top of <a href="https://github.com/valyala/fasthttp">Fasthttp</a>, the <b>fastest</b> HTTP engine for <a href="https://go.dev/doc/">Go</a>. Designed to <b>ease</b> things up for <b>fast</b> development with <a href="https://docs.gofiber.io/#zero-allocation"><b>zero memory allocation</b></a> and <b>performance</b> in mind.</em>
 </p>
@@ -57,7 +57,7 @@ This command fetches the Fiber package and adds it to your project's dependencie
 
 ## ⚡️ Quickstart
 
-Getting started with Fiber is easy. Here's a basic example to create a simple web server that responds with "Hello, World 👋!" on the root path. This example demonstrates initializing a new Fiber app, setting up a route, and starting the server. 
+Getting started with Fiber is easy. Here's a basic example to create a simple web server that responds with "Hello, World 👋!" on the root path. This example demonstrates initializing a new Fiber app, setting up a route, and starting the server.
 
 ```go
 package main
@@ -100,19 +100,19 @@ These tests are performed by [TechEmpower](https://www.techempower.com/benchmark
 
 ## 🎯 Features
 
--   Robust [Routing](https://docs.gofiber.io/guide/routing)
--   Serve [Static Files](https://docs.gofiber.io/api/app#static)
--   Extreme [Performance](https://docs.gofiber.io/extra/benchmarks)
--   [Low Memory](https://docs.gofiber.io/extra/benchmarks) footprint
--   [API Endpoints](https://docs.gofiber.io/api/ctx)
--   [Middleware](https://docs.gofiber.io/category/-middleware) & [Next](https://docs.gofiber.io/api/ctx#next) support
--   [Rapid](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) server-side programming
--   [Template Engines](https://github.com/gofiber/template)
--   [WebSocket Support](https://github.com/gofiber/contrib/tree/main/websocket)
--   [Socket.io Support](https://github.com/gofiber/contrib/tree/main/socketio)
--   [Server-Sent Events](https://github.com/gofiber/recipes/tree/master/sse)
--   [Rate Limiter](https://docs.gofiber.io/api/middleware/limiter)
--   And much more, [explore Fiber](https://docs.gofiber.io/)
+- Robust [Routing](https://docs.gofiber.io/guide/routing)
+- Serve [Static Files](https://docs.gofiber.io/api/app#static)
+- Extreme [Performance](https://docs.gofiber.io/extra/benchmarks)
+- [Low Memory](https://docs.gofiber.io/extra/benchmarks) footprint
+- [API Endpoints](https://docs.gofiber.io/api/ctx)
+- [Middleware](https://docs.gofiber.io/category/-middleware) & [Next](https://docs.gofiber.io/api/ctx#next) support
+- [Rapid](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) server-side programming
+- [Template Engines](https://github.com/gofiber/template)
+- [WebSocket Support](https://github.com/gofiber/contrib/tree/main/websocket)
+- [Socket.io Support](https://github.com/gofiber/contrib/tree/main/socketio)
+- [Server-Sent Events](https://github.com/gofiber/recipes/tree/master/sse)
+- [Rate Limiter](https://docs.gofiber.io/api/middleware/limiter)
+- And much more, [explore Fiber](https://docs.gofiber.io/)
 
 ## 💡 Philosophy
 
@@ -124,14 +124,14 @@ We **listen** to our users in [issues](https://github.com/gofiber/fiber/issues),
 
 ## ⚠️ Limitations
 
--   Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber v3 has been tested with Go versions 1.21 and 1.22.
--   Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.
+- Due to Fiber's usage of unsafe, the library may not always be compatible with the latest Go version. Fiber v3 has been tested with Go versions 1.21 and 1.22.
+- Fiber is not compatible with net/http interfaces. This means you will not be able to use projects like gqlgen, go-swagger, or any others which are part of the net/http ecosystem.
 
 ## 👀 Examples
 
 Listed below are some of the common examples. If you want to see more code examples, please visit our [Recipes repository](https://github.com/gofiber/recipes) or visit our hosted [API documentation](https://docs.gofiber.io).
 
-#### 📖 [**Basic Routing**](https://docs.gofiber.io/#basic-routing)
+### 📖 [**Basic Routing**](https://docs.gofiber.io/#basic-routing)
 
 ```go
 func main() {
@@ -634,14 +634,14 @@ If you want to say **Thank You** and/or support the active development of `Fiber
 
 To ensure your contributions are ready for a Pull Request, please use the following `Makefile` commands. These tools help maintain code quality, consistency.
 
-* **make help**: Display available commands.
-* **make audit**: Conduct quality checks.
-* **make benchmark**: Benchmark code performance.
-* **make coverage**: Generate test coverage report.
-* **make format**: Automatically format code.
-* **make lint**: Run lint checks.
-* **make test**: Execute all tests.
-* **make tidy**: Tidy dependencies.
+- **make help**: Display available commands.
+- **make audit**: Conduct quality checks.
+- **make benchmark**: Benchmark code performance.
+- **make coverage**: Generate test coverage report.
+- **make format**: Automatically format code.
+- **make lint**: Run lint checks.
+- **make test**: Execute all tests.
+- **make tidy**: Tidy dependencies.
 
 Run these commands to ensure your code adheres to project standards and best practices.
 

diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -6,6 +6,7 @@
 4. [Incident Response Process](#process)
 
 <a name="versions"></a>
+
 ## Supported Versions
 
 The table below shows the supported versions for Fiber which include security updates.
@@ -16,6 +17,7 @@ The table below shows the supported versions for Fiber which include security up
 | < 1.12.6  | :x:                |
 
 <a name="reporting"></a>
+
 ## Reporting security problems to Fiber
 
 **DO NOT CREATE AN ISSUE** to report a security problem. Instead, please
@@ -24,6 +26,7 @@ send us an e-mail at `[email protected]` or join our discord server via
 to Fenny or any of the maintainers.
 
 <a name="contact"></a>
+
 ## Security Point of Contact
 
 The security point of contact is [Fenny](https://github.com/Fenny). Fenny responds
@@ -35,6 +38,7 @@ of contact are any of the [@maintainers](https://github.com/orgs/gofiber/teams/m
 The maintainers are the only other persons with administrative access to Fiber's source code.
 
 <a name="process"></a>
+
 ## Incident Response Process
 
 In case an incident is discovered or reported, we will follow the following
@@ -73,4 +77,4 @@ for all of it's members.
 We learn about critical software updates and security threats from these sources
 
 1. GitHub Security Alerts
-2. GitHub: https://status.github.com/ & [@githubstatus](https://twitter.com/githubstatus)
+2. GitHub: <https://status.github.com/> & [@githubstatus](https://twitter.com/githubstatus)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,4 +1,4 @@
-## Description
+# Description
 
 Please provide a clear and concise description of the changes you've made and the problem they address. Include the purpose of the change, any relevant issues it solves, and the benefits it brings to the project. If this change introduces new features or adjustments, highlight them here.
 

diff --git a/.github/workflows/auto-labeler.yml b/.github/workflows/auto-labeler.yml
@@ -5,6 +5,7 @@ on:
     types: [opened, edited, milestoned]
   pull_request_target:
     types: [opened]
+
 permissions:
   contents: read
   issues: write

diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -3,15 +3,11 @@ on:
     branches:
       - master
       - main
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
   pull_request:
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
 
 name: Benchmark
 jobs:

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -5,15 +5,11 @@ on:
     branches:
       - master
       - main
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
   pull_request:
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
   schedule:
     - cron: "0 3 * * 6"
 

diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -6,7 +6,11 @@ on:
     branches:
       - master
       - main
+    paths-ignore:
+      - "**/*.md"
   pull_request:
+    paths-ignore:
+      - "**/*.md"
 
 permissions:
   # Required: allow read access to the content for analysis.

diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml
@@ -0,0 +1,25 @@
+name: markdownlint
+
+on:
+  push:
+    branches:
+      - master
+      - main
+    paths:
+      - "**/*.md"
+  pull_request:
+    paths:
+      - "**/*.md"
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v4
+
+      - name: Run markdownlint-cli2
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: |
+            **/*.md
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,15 +5,11 @@ on:
     branches:
       - master
       - main
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
   pull_request:
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
 
 jobs:
   unit:

diff --git a/.github/workflows/vulncheck.yml b/.github/workflows/vulncheck.yml
@@ -5,15 +5,11 @@ on:
     branches:
       - master
       - main
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
   pull_request:
-    paths:
-      - "**"
-      - "!docs/**"
-      - "!**.md"
+    paths-ignore:
+      - "**/*.md"
 
 jobs:
   govulncheck-check: