fix docs

crysmags · Feb 27, 2024 · 4ae9d61 · 4ae9d61
1 parent aa8bf4a
commit 4ae9d61
Show file tree

Hide file tree

Showing 51 changed files with 5 additions and 5 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -13,7 +13,7 @@ updates:
     open-pull-requests-limit: 10
 
   - package-ecosystem: "npm"
-    directory: /documentation
+    directory: /docs
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 10

diff --git a/.npmignore b/.npmignore
@@ -9,4 +9,4 @@ lib/llhttp/llhttp.wasm
 
 !types/**/*
 !index.d.ts
-!documentation/docs/**/*
+!docs/docs/**/*
diff --git a/README.md b/README.md
@@ -1 +1 @@
-documentation/README.md
+docs/README.md
diff --git a/.nojekyll → docs/.nojekyll b/.nojekyll → docs/.nojekyll
diff --git a/CNAME → docs/CNAME b/CNAME → docs/CNAME
diff --git a/documentation/README.md → docs/README.md b/documentation/README.md → docs/README.md
diff --git a/documentation/docs/api/Agent.md → docs/docs/api/Agent.md b/documentation/docs/api/Agent.md → docs/docs/api/Agent.md
diff --git a/documentation/docs/api/BalancedPool.md → docs/docs/api/BalancedPool.md b/documentation/docs/api/BalancedPool.md → docs/docs/api/BalancedPool.md
diff --git a/documentation/docs/api/CacheStorage.md → docs/docs/api/CacheStorage.md b/documentation/docs/api/CacheStorage.md → docs/docs/api/CacheStorage.md
diff --git a/documentation/docs/api/Client.md → docs/docs/api/Client.md b/documentation/docs/api/Client.md → docs/docs/api/Client.md
diff --git a/documentation/docs/api/Connector.md → docs/docs/api/Connector.md b/documentation/docs/api/Connector.md → docs/docs/api/Connector.md
diff --git a/documentation/docs/api/ContentType.md → docs/docs/api/ContentType.md b/documentation/docs/api/ContentType.md → docs/docs/api/ContentType.md
diff --git a/documentation/docs/api/Cookies.md → docs/docs/api/Cookies.md b/documentation/docs/api/Cookies.md → docs/docs/api/Cookies.md
diff --git a/documentation/docs/api/Debug.md → docs/docs/api/Debug.md b/documentation/docs/api/Debug.md → docs/docs/api/Debug.md
diff --git a/documentation/docs/api/DiagnosticsChannel.md → docs/docs/api/DiagnosticsChannel.md b/documentation/docs/api/DiagnosticsChannel.md → docs/docs/api/DiagnosticsChannel.md
diff --git a/...mentation/docs/api/DispatchInterceptor.md → docs/docs/api/DispatchInterceptor.md b/...mentation/docs/api/DispatchInterceptor.md → docs/docs/api/DispatchInterceptor.md
diff --git a/documentation/docs/api/Dispatcher.md → docs/docs/api/Dispatcher.md b/documentation/docs/api/Dispatcher.md → docs/docs/api/Dispatcher.md
diff --git a/documentation/docs/api/Errors.md → docs/docs/api/Errors.md b/documentation/docs/api/Errors.md → docs/docs/api/Errors.md
diff --git a/documentation/docs/api/EventSource.md → docs/docs/api/EventSource.md b/documentation/docs/api/EventSource.md → docs/docs/api/EventSource.md
diff --git a/documentation/docs/api/Fetch.md → docs/docs/api/Fetch.md b/documentation/docs/api/Fetch.md → docs/docs/api/Fetch.md
diff --git a/documentation/docs/api/MockAgent.md → docs/docs/api/MockAgent.md b/documentation/docs/api/MockAgent.md → docs/docs/api/MockAgent.md
diff --git a/documentation/docs/api/MockClient.md → docs/docs/api/MockClient.md b/documentation/docs/api/MockClient.md → docs/docs/api/MockClient.md
diff --git a/documentation/docs/api/MockErrors.md → docs/docs/api/MockErrors.md b/documentation/docs/api/MockErrors.md → docs/docs/api/MockErrors.md
diff --git a/documentation/docs/api/MockPool.md → docs/docs/api/MockPool.md b/documentation/docs/api/MockPool.md → docs/docs/api/MockPool.md
diff --git a/documentation/docs/api/Pool.md → docs/docs/api/Pool.md b/documentation/docs/api/Pool.md → docs/docs/api/Pool.md
diff --git a/documentation/docs/api/PoolStats.md → docs/docs/api/PoolStats.md b/documentation/docs/api/PoolStats.md → docs/docs/api/PoolStats.md
diff --git a/documentation/docs/api/ProxyAgent.md → docs/docs/api/ProxyAgent.md b/documentation/docs/api/ProxyAgent.md → docs/docs/api/ProxyAgent.md
diff --git a/documentation/docs/api/RedirectHandler.md → docs/docs/api/RedirectHandler.md b/documentation/docs/api/RedirectHandler.md → docs/docs/api/RedirectHandler.md
diff --git a/documentation/docs/api/RetryAgent.md → docs/docs/api/RetryAgent.md b/documentation/docs/api/RetryAgent.md → docs/docs/api/RetryAgent.md
diff --git a/documentation/docs/api/RetryHandler.md → docs/docs/api/RetryHandler.md b/documentation/docs/api/RetryHandler.md → docs/docs/api/RetryHandler.md
diff --git a/documentation/docs/api/Util.md → docs/docs/api/Util.md b/documentation/docs/api/Util.md → docs/docs/api/Util.md
diff --git a/documentation/docs/api/WebSocket.md → docs/docs/api/WebSocket.md b/documentation/docs/api/WebSocket.md → docs/docs/api/WebSocket.md
diff --git a/documentation/docs/api/api-lifecycle.md → docs/docs/api/api-lifecycle.md b/documentation/docs/api/api-lifecycle.md → docs/docs/api/api-lifecycle.md
diff --git a/...docs/best-practices/client-certificate.md → ...docs/best-practices/client-certificate.md b/...docs/best-practices/client-certificate.md → ...docs/best-practices/client-certificate.md
diff --git a/...on/docs/best-practices/mocking-request.md → docs/docs/best-practices/mocking-request.md b/...on/docs/best-practices/mocking-request.md → docs/docs/best-practices/mocking-request.md
diff --git a/documentation/docs/best-practices/proxy.md → docs/docs/best-practices/proxy.md b/documentation/docs/best-practices/proxy.md → docs/docs/best-practices/proxy.md
diff --git a/...tion/docs/best-practices/writing-tests.md → docs/docs/best-practices/writing-tests.md b/...tion/docs/best-practices/writing-tests.md → docs/docs/best-practices/writing-tests.md
diff --git a/documentation/docsify/sidebar.md → docs/docsify/sidebar.md b/documentation/docsify/sidebar.md → docs/docsify/sidebar.md
diff --git a/documentation/examples/README.md → docs/examples/README.md b/documentation/examples/README.md → docs/examples/README.md
diff --git a/...entation/examples/ca-fingerprint/index.js → docs/examples/ca-fingerprint/index.js b/...entation/examples/ca-fingerprint/index.js → docs/examples/ca-fingerprint/index.js
diff --git a/documentation/examples/eventsource.js → docs/examples/eventsource.js b/documentation/examples/eventsource.js → docs/examples/eventsource.js
diff --git a/documentation/examples/fetch.js → docs/examples/fetch.js b/documentation/examples/fetch.js → docs/examples/fetch.js
diff --git a/documentation/examples/proxy-agent.js → docs/examples/proxy-agent.js b/documentation/examples/proxy-agent.js → docs/examples/proxy-agent.js
diff --git a/documentation/examples/proxy/index.js → docs/examples/proxy/index.js b/documentation/examples/proxy/index.js → docs/examples/proxy/index.js
diff --git a/documentation/examples/proxy/proxy.js → docs/examples/proxy/proxy.js b/documentation/examples/proxy/proxy.js → docs/examples/proxy/proxy.js
diff --git a/documentation/examples/proxy/websocket.js → docs/examples/proxy/websocket.js b/documentation/examples/proxy/websocket.js → docs/examples/proxy/websocket.js
diff --git a/documentation/examples/request.js → docs/examples/request.js b/documentation/examples/request.js → docs/examples/request.js
diff --git a/documentation/index.html → docs/index.html b/documentation/index.html → docs/index.html
diff --git a/documentation/package.json → docs/package.json b/documentation/package.json → docs/package.json
diff --git a/package.json b/package.json
@@ -86,7 +86,7 @@
     "bench:server": "node benchmarks/server.js",
     "prebench:run": "node benchmarks/wait.js",
     "bench:run": "SAMPLES=100 CONNECTIONS=50 node benchmarks/benchmark.js",
-    "serve:website": "echo \"Error: Documentation has been moved to '\/documentation'\" && exit 1",
+    "serve:website": "echo \"Error: Documentation has been moved to '\/docs'\" && exit 1",
     "prepare": "husky install",
     "fuzz": "jsfuzz test/fuzzing/fuzz.js corpus"
   },

diff --git a/test/examples.js b/test/examples.js
@@ -4,7 +4,7 @@ const { tspl } = require('@matteo.collina/tspl')
 const { createServer } = require('node:http')
 const { test, after } = require('node:test')
 const { once } = require('node:events')
-const examples = require('../documentation/examples/request.js')
+const examples = require('../docs/examples/request.js')
 
 test('request examples', async (t) => {
   t = tspl(t, { plan: 7 })