[v3-Maintenance]-Consolidate-and-Document-Core-Changes-in-v3

gofiber · Apr 20, 2024 · 22786d2 · 22786d2
1 parent 0e29268
commit 22786d2
Show file tree

Hide file tree

Showing 35 changed files with 12 additions and 11 deletions.
diff --git a/docs/core/api/_category_.json b/docs/core/api/_category_.json
@@ -1,5 +1,5 @@
 {
-  "label": "API",
+  "label": "\uD83D\uDEE0\uFE0F Api",
   "position": 2,
   "link": {
     "type": "generated-index",

diff --git a/docs/core/api/ctx.md b/docs/core/api/ctx.md
@@ -1717,7 +1717,7 @@ app.Get("/file-with-url-chars", func(c fiber.Ctx) error {
 ```
 
 :::info
-For sending files from embedded file system [this functionality](./middleware/filesystem.md#sendfile) can be used
+For sending files from embedded file system [this functionality](../middleware/filesystem.md#sendfile) can be used
 :::
 
 ## SendStatus

diff --git a/docs/core/extra/_category_.json b/docs/core/extra/_category_.json
@@ -1,8 +1,8 @@
 {
-  "label": "Extra",
-  "position": 4,
+  "label": "\uD83E\uDDE9 Extra",
+  "position": 5,
   "link": {
     "type": "generated-index",
     "description": "Extra contents for Fiber."
   }
-}
+}
diff --git a/docs/core/guide/_category_.json b/docs/core/guide/_category_.json
@@ -1,6 +1,6 @@
 {
-  "label": "Guide",
-  "position": 3,
+  "label": "\uD83D\uDCD6 Guide",
+  "position": 4,
   "link": {
     "type": "generated-index",
     "description": "Guides for Fiber."

diff --git a/docs/core/api/middleware/_category_.json → docs/core/middleware/_category_.json b/docs/core/api/middleware/_category_.json → docs/core/middleware/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "🧬 Middleware",
-  "position": 11,
+  "position": 3,
   "collapsed": true,
   "link": {
     "type": "generated-index",

diff --git a/docs/core/api/middleware/adaptor.md → docs/core/middleware/adaptor.md b/docs/core/api/middleware/adaptor.md → docs/core/middleware/adaptor.md
diff --git a/docs/core/api/middleware/basicauth.md → docs/core/middleware/basicauth.md b/docs/core/api/middleware/basicauth.md → docs/core/middleware/basicauth.md
diff --git a/docs/core/api/middleware/cache.md → docs/core/middleware/cache.md b/docs/core/api/middleware/cache.md → docs/core/middleware/cache.md
diff --git a/docs/core/api/middleware/compress.md → docs/core/middleware/compress.md b/docs/core/api/middleware/compress.md → docs/core/middleware/compress.md
diff --git a/docs/core/api/middleware/cors.md → docs/core/middleware/cors.md b/docs/core/api/middleware/cors.md → docs/core/middleware/cors.md
diff --git a/docs/core/api/middleware/csrf.md → docs/core/middleware/csrf.md b/docs/core/api/middleware/csrf.md → docs/core/middleware/csrf.md
diff --git a/docs/core/api/middleware/earlydata.md → docs/core/middleware/earlydata.md b/docs/core/api/middleware/earlydata.md → docs/core/middleware/earlydata.md
diff --git a/docs/core/api/middleware/encryptcookie.md → docs/core/middleware/encryptcookie.md b/docs/core/api/middleware/encryptcookie.md → docs/core/middleware/encryptcookie.md
diff --git a/docs/core/api/middleware/envvar.md → docs/core/middleware/envvar.md b/docs/core/api/middleware/envvar.md → docs/core/middleware/envvar.md
diff --git a/docs/core/api/middleware/etag.md → docs/core/middleware/etag.md b/docs/core/api/middleware/etag.md → docs/core/middleware/etag.md
diff --git a/docs/core/api/middleware/expvar.md → docs/core/middleware/expvar.md b/docs/core/api/middleware/expvar.md → docs/core/middleware/expvar.md
diff --git a/docs/core/api/middleware/favicon.md → docs/core/middleware/favicon.md b/docs/core/api/middleware/favicon.md → docs/core/middleware/favicon.md
diff --git a/docs/core/api/middleware/filesystem.md → docs/core/middleware/filesystem.md b/docs/core/api/middleware/filesystem.md → docs/core/middleware/filesystem.md
diff --git a/docs/core/api/middleware/healthcheck.md → docs/core/middleware/healthcheck.md b/docs/core/api/middleware/healthcheck.md → docs/core/middleware/healthcheck.md
diff --git a/docs/core/api/middleware/helmet.md → docs/core/middleware/helmet.md b/docs/core/api/middleware/helmet.md → docs/core/middleware/helmet.md
diff --git a/docs/core/api/middleware/idempotency.md → docs/core/middleware/idempotency.md b/docs/core/api/middleware/idempotency.md → docs/core/middleware/idempotency.md
diff --git a/docs/core/api/middleware/keyauth.md → docs/core/middleware/keyauth.md b/docs/core/api/middleware/keyauth.md → docs/core/middleware/keyauth.md
diff --git a/docs/core/api/middleware/limiter.md → docs/core/middleware/limiter.md b/docs/core/api/middleware/limiter.md → docs/core/middleware/limiter.md
diff --git a/docs/core/api/middleware/logger.md → docs/core/middleware/logger.md b/docs/core/api/middleware/logger.md → docs/core/middleware/logger.md
diff --git a/docs/core/api/middleware/monitor.md → docs/core/middleware/monitor.md b/docs/core/api/middleware/monitor.md → docs/core/middleware/monitor.md
diff --git a/docs/core/api/middleware/pprof.md → docs/core/middleware/pprof.md b/docs/core/api/middleware/pprof.md → docs/core/middleware/pprof.md
diff --git a/docs/core/api/middleware/proxy.md → docs/core/middleware/proxy.md b/docs/core/api/middleware/proxy.md → docs/core/middleware/proxy.md
diff --git a/docs/core/api/middleware/recover.md → docs/core/middleware/recover.md b/docs/core/api/middleware/recover.md → docs/core/middleware/recover.md
diff --git a/docs/core/api/middleware/redirect.md → docs/core/middleware/redirect.md b/docs/core/api/middleware/redirect.md → docs/core/middleware/redirect.md
diff --git a/docs/core/api/middleware/requestid.md → docs/core/middleware/requestid.md b/docs/core/api/middleware/requestid.md → docs/core/middleware/requestid.md
diff --git a/docs/core/api/middleware/rewrite.md → docs/core/middleware/rewrite.md b/docs/core/api/middleware/rewrite.md → docs/core/middleware/rewrite.md
diff --git a/docs/core/api/middleware/session.md → docs/core/middleware/session.md b/docs/core/api/middleware/session.md → docs/core/middleware/session.md
diff --git a/docs/core/api/middleware/skip.md → docs/core/middleware/skip.md b/docs/core/api/middleware/skip.md → docs/core/middleware/skip.md
diff --git a/docs/core/api/middleware/timeout.md → docs/core/middleware/timeout.md b/docs/core/api/middleware/timeout.md → docs/core/middleware/timeout.md
diff --git a/sidebars.js b/sidebars.js
@@ -16,9 +16,10 @@ const sidebars = {
   tutorialSidebar: [
       {type: 'doc', id: 'welcome'},
       {type: 'doc', id: 'whats_new'},
-      {type: 'category', label: 'API', link: {type: 'generated-index', description: 'API documentation for Fiber.'}, items: [{type: 'autogenerated', dirName: 'api'}]},
-      {type: 'category', label: 'Guide', link: {type: 'generated-index', description: 'Guides for Fiber.'}, items: [{type: 'autogenerated', dirName: 'guide'}]},
-      {type: 'category', label: 'Extra', link: {type: 'generated-index', description: 'Extra contents for Fiber.'}, items: [{type: 'autogenerated', dirName: 'extra'}]},
+      {type: 'category', label: '🛠️ Api', link: {type: 'generated-index', description: 'API documentation for Fiber.'}, items: [{type: 'autogenerated', dirName: 'api'}]},
+      {type: 'category', label: '🧬 Middleware', link: {type: 'generated-index', description: 'Middleware is a function chained in the HTTP request cycle with access to the Context which it uses to perform a specific action, for example, logging every request or enabling CORS.'}, items: [{type: 'autogenerated', dirName: 'middleware'}], collapsed: true},
+      {type: 'category', label: '📖 Guide', link: {type: 'generated-index', description: 'Guides for Fiber.'}, items: [{type: 'autogenerated', dirName: 'guide'}]},
+      {type: 'category', label: '🧩 Extra', link: {type: 'generated-index', description: 'Extra contents for Fiber.'}, items: [{type: 'autogenerated', dirName: 'extra'}]},
       // replace this without partials folder when the exclude feature is there fo rthe autogenerated feature
       // {type: 'autogenerated', dirName: '.'}
   ],
-Original file line number
+Diff line change
@@ Expand Up / @@ -1717,7 +1717,7 @@ app.Get("/file-with-url-chars", func(c fiber.Ctx) error { @@
     ```
     :::info
-    For sending files from embedded file system [this functionality](./middleware/filesystem.md#sendfile) can be used
+    For sending files from embedded file system [this functionality](../middleware/filesystem.md#sendfile) can be used
     :::
     ## SendStatus
@@ Expand Down @@