From 4ae9d613d6a997bd478cd7eb271082dd7f693df5 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Thu, 22 Feb 2024 16:55:53 -0800 Subject: [PATCH] fix docs --- .github/dependabot.yml | 2 +- .npmignore | 2 +- README.md | 2 +- .nojekyll => docs/.nojekyll | 0 CNAME => docs/CNAME | 0 {documentation => docs}/README.md | 0 {documentation => docs}/docs/api/Agent.md | 0 {documentation => docs}/docs/api/BalancedPool.md | 0 {documentation => docs}/docs/api/CacheStorage.md | 0 {documentation => docs}/docs/api/Client.md | 0 {documentation => docs}/docs/api/Connector.md | 0 {documentation => docs}/docs/api/ContentType.md | 0 {documentation => docs}/docs/api/Cookies.md | 0 {documentation => docs}/docs/api/Debug.md | 0 {documentation => docs}/docs/api/DiagnosticsChannel.md | 0 {documentation => docs}/docs/api/DispatchInterceptor.md | 0 {documentation => docs}/docs/api/Dispatcher.md | 0 {documentation => docs}/docs/api/Errors.md | 0 {documentation => docs}/docs/api/EventSource.md | 0 {documentation => docs}/docs/api/Fetch.md | 0 {documentation => docs}/docs/api/MockAgent.md | 0 {documentation => docs}/docs/api/MockClient.md | 0 {documentation => docs}/docs/api/MockErrors.md | 0 {documentation => docs}/docs/api/MockPool.md | 0 {documentation => docs}/docs/api/Pool.md | 0 {documentation => docs}/docs/api/PoolStats.md | 0 {documentation => docs}/docs/api/ProxyAgent.md | 0 {documentation => docs}/docs/api/RedirectHandler.md | 0 {documentation => docs}/docs/api/RetryAgent.md | 0 {documentation => docs}/docs/api/RetryHandler.md | 0 {documentation => docs}/docs/api/Util.md | 0 {documentation => docs}/docs/api/WebSocket.md | 0 {documentation => docs}/docs/api/api-lifecycle.md | 0 .../docs/best-practices/client-certificate.md | 0 {documentation => docs}/docs/best-practices/mocking-request.md | 0 {documentation => docs}/docs/best-practices/proxy.md | 0 {documentation => docs}/docs/best-practices/writing-tests.md | 0 {documentation => docs}/docsify/sidebar.md | 0 {documentation => docs}/examples/README.md | 0 {documentation => docs}/examples/ca-fingerprint/index.js | 0 {documentation => docs}/examples/eventsource.js | 0 {documentation => docs}/examples/fetch.js | 0 {documentation => docs}/examples/proxy-agent.js | 0 {documentation => docs}/examples/proxy/index.js | 0 {documentation => docs}/examples/proxy/proxy.js | 0 {documentation => docs}/examples/proxy/websocket.js | 0 {documentation => docs}/examples/request.js | 0 {documentation => docs}/index.html | 0 {documentation => docs}/package.json | 0 package.json | 2 +- test/examples.js | 2 +- 51 files changed, 5 insertions(+), 5 deletions(-) rename .nojekyll => docs/.nojekyll (100%) rename CNAME => docs/CNAME (100%) rename {documentation => docs}/README.md (100%) rename {documentation => docs}/docs/api/Agent.md (100%) rename {documentation => docs}/docs/api/BalancedPool.md (100%) rename {documentation => docs}/docs/api/CacheStorage.md (100%) rename {documentation => docs}/docs/api/Client.md (100%) rename {documentation => docs}/docs/api/Connector.md (100%) rename {documentation => docs}/docs/api/ContentType.md (100%) rename {documentation => docs}/docs/api/Cookies.md (100%) rename {documentation => docs}/docs/api/Debug.md (100%) rename {documentation => docs}/docs/api/DiagnosticsChannel.md (100%) rename {documentation => docs}/docs/api/DispatchInterceptor.md (100%) rename {documentation => docs}/docs/api/Dispatcher.md (100%) rename {documentation => docs}/docs/api/Errors.md (100%) rename {documentation => docs}/docs/api/EventSource.md (100%) rename {documentation => docs}/docs/api/Fetch.md (100%) rename {documentation => docs}/docs/api/MockAgent.md (100%) rename {documentation => docs}/docs/api/MockClient.md (100%) rename {documentation => docs}/docs/api/MockErrors.md (100%) rename {documentation => docs}/docs/api/MockPool.md (100%) rename {documentation => docs}/docs/api/Pool.md (100%) rename {documentation => docs}/docs/api/PoolStats.md (100%) rename {documentation => docs}/docs/api/ProxyAgent.md (100%) rename {documentation => docs}/docs/api/RedirectHandler.md (100%) rename {documentation => docs}/docs/api/RetryAgent.md (100%) rename {documentation => docs}/docs/api/RetryHandler.md (100%) rename {documentation => docs}/docs/api/Util.md (100%) rename {documentation => docs}/docs/api/WebSocket.md (100%) rename {documentation => docs}/docs/api/api-lifecycle.md (100%) rename {documentation => docs}/docs/best-practices/client-certificate.md (100%) rename {documentation => docs}/docs/best-practices/mocking-request.md (100%) rename {documentation => docs}/docs/best-practices/proxy.md (100%) rename {documentation => docs}/docs/best-practices/writing-tests.md (100%) rename {documentation => docs}/docsify/sidebar.md (100%) rename {documentation => docs}/examples/README.md (100%) rename {documentation => docs}/examples/ca-fingerprint/index.js (100%) rename {documentation => docs}/examples/eventsource.js (100%) rename {documentation => docs}/examples/fetch.js (100%) rename {documentation => docs}/examples/proxy-agent.js (100%) rename {documentation => docs}/examples/proxy/index.js (100%) rename {documentation => docs}/examples/proxy/proxy.js (100%) rename {documentation => docs}/examples/proxy/websocket.js (100%) rename {documentation => docs}/examples/request.js (100%) rename {documentation => docs}/index.html (100%) rename {documentation => docs}/package.json (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ec90956a8ea..49b8cc8a17a 100644 --- 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 index a00ceea145e..003eb6c62ff 100644 --- 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 index c95b8a6a153..0e01b4308c1 120000 --- a/README.md +++ b/README.md @@ -1 +1 @@ -documentation/README.md \ No newline at end of file +docs/README.md \ No newline at end of file diff --git a/.nojekyll b/docs/.nojekyll similarity index 100% rename from .nojekyll rename to docs/.nojekyll diff --git a/CNAME b/docs/CNAME similarity index 100% rename from CNAME rename to docs/CNAME diff --git a/documentation/README.md b/docs/README.md similarity index 100% rename from documentation/README.md rename to docs/README.md diff --git a/documentation/docs/api/Agent.md b/docs/docs/api/Agent.md similarity index 100% rename from documentation/docs/api/Agent.md rename to docs/docs/api/Agent.md diff --git a/documentation/docs/api/BalancedPool.md b/docs/docs/api/BalancedPool.md similarity index 100% rename from documentation/docs/api/BalancedPool.md rename to docs/docs/api/BalancedPool.md diff --git a/documentation/docs/api/CacheStorage.md b/docs/docs/api/CacheStorage.md similarity index 100% rename from documentation/docs/api/CacheStorage.md rename to docs/docs/api/CacheStorage.md diff --git a/documentation/docs/api/Client.md b/docs/docs/api/Client.md similarity index 100% rename from documentation/docs/api/Client.md rename to docs/docs/api/Client.md diff --git a/documentation/docs/api/Connector.md b/docs/docs/api/Connector.md similarity index 100% rename from documentation/docs/api/Connector.md rename to docs/docs/api/Connector.md diff --git a/documentation/docs/api/ContentType.md b/docs/docs/api/ContentType.md similarity index 100% rename from documentation/docs/api/ContentType.md rename to docs/docs/api/ContentType.md diff --git a/documentation/docs/api/Cookies.md b/docs/docs/api/Cookies.md similarity index 100% rename from documentation/docs/api/Cookies.md rename to docs/docs/api/Cookies.md diff --git a/documentation/docs/api/Debug.md b/docs/docs/api/Debug.md similarity index 100% rename from documentation/docs/api/Debug.md rename to docs/docs/api/Debug.md diff --git a/documentation/docs/api/DiagnosticsChannel.md b/docs/docs/api/DiagnosticsChannel.md similarity index 100% rename from documentation/docs/api/DiagnosticsChannel.md rename to docs/docs/api/DiagnosticsChannel.md diff --git a/documentation/docs/api/DispatchInterceptor.md b/docs/docs/api/DispatchInterceptor.md similarity index 100% rename from documentation/docs/api/DispatchInterceptor.md rename to docs/docs/api/DispatchInterceptor.md diff --git a/documentation/docs/api/Dispatcher.md b/docs/docs/api/Dispatcher.md similarity index 100% rename from documentation/docs/api/Dispatcher.md rename to docs/docs/api/Dispatcher.md diff --git a/documentation/docs/api/Errors.md b/docs/docs/api/Errors.md similarity index 100% rename from documentation/docs/api/Errors.md rename to docs/docs/api/Errors.md diff --git a/documentation/docs/api/EventSource.md b/docs/docs/api/EventSource.md similarity index 100% rename from documentation/docs/api/EventSource.md rename to docs/docs/api/EventSource.md diff --git a/documentation/docs/api/Fetch.md b/docs/docs/api/Fetch.md similarity index 100% rename from documentation/docs/api/Fetch.md rename to docs/docs/api/Fetch.md diff --git a/documentation/docs/api/MockAgent.md b/docs/docs/api/MockAgent.md similarity index 100% rename from documentation/docs/api/MockAgent.md rename to docs/docs/api/MockAgent.md diff --git a/documentation/docs/api/MockClient.md b/docs/docs/api/MockClient.md similarity index 100% rename from documentation/docs/api/MockClient.md rename to docs/docs/api/MockClient.md diff --git a/documentation/docs/api/MockErrors.md b/docs/docs/api/MockErrors.md similarity index 100% rename from documentation/docs/api/MockErrors.md rename to docs/docs/api/MockErrors.md diff --git a/documentation/docs/api/MockPool.md b/docs/docs/api/MockPool.md similarity index 100% rename from documentation/docs/api/MockPool.md rename to docs/docs/api/MockPool.md diff --git a/documentation/docs/api/Pool.md b/docs/docs/api/Pool.md similarity index 100% rename from documentation/docs/api/Pool.md rename to docs/docs/api/Pool.md diff --git a/documentation/docs/api/PoolStats.md b/docs/docs/api/PoolStats.md similarity index 100% rename from documentation/docs/api/PoolStats.md rename to docs/docs/api/PoolStats.md diff --git a/documentation/docs/api/ProxyAgent.md b/docs/docs/api/ProxyAgent.md similarity index 100% rename from documentation/docs/api/ProxyAgent.md rename to docs/docs/api/ProxyAgent.md diff --git a/documentation/docs/api/RedirectHandler.md b/docs/docs/api/RedirectHandler.md similarity index 100% rename from documentation/docs/api/RedirectHandler.md rename to docs/docs/api/RedirectHandler.md diff --git a/documentation/docs/api/RetryAgent.md b/docs/docs/api/RetryAgent.md similarity index 100% rename from documentation/docs/api/RetryAgent.md rename to docs/docs/api/RetryAgent.md diff --git a/documentation/docs/api/RetryHandler.md b/docs/docs/api/RetryHandler.md similarity index 100% rename from documentation/docs/api/RetryHandler.md rename to docs/docs/api/RetryHandler.md diff --git a/documentation/docs/api/Util.md b/docs/docs/api/Util.md similarity index 100% rename from documentation/docs/api/Util.md rename to docs/docs/api/Util.md diff --git a/documentation/docs/api/WebSocket.md b/docs/docs/api/WebSocket.md similarity index 100% rename from documentation/docs/api/WebSocket.md rename to docs/docs/api/WebSocket.md diff --git a/documentation/docs/api/api-lifecycle.md b/docs/docs/api/api-lifecycle.md similarity index 100% rename from documentation/docs/api/api-lifecycle.md rename to docs/docs/api/api-lifecycle.md diff --git a/documentation/docs/best-practices/client-certificate.md b/docs/docs/best-practices/client-certificate.md similarity index 100% rename from documentation/docs/best-practices/client-certificate.md rename to docs/docs/best-practices/client-certificate.md diff --git a/documentation/docs/best-practices/mocking-request.md b/docs/docs/best-practices/mocking-request.md similarity index 100% rename from documentation/docs/best-practices/mocking-request.md rename to docs/docs/best-practices/mocking-request.md diff --git a/documentation/docs/best-practices/proxy.md b/docs/docs/best-practices/proxy.md similarity index 100% rename from documentation/docs/best-practices/proxy.md rename to docs/docs/best-practices/proxy.md diff --git a/documentation/docs/best-practices/writing-tests.md b/docs/docs/best-practices/writing-tests.md similarity index 100% rename from documentation/docs/best-practices/writing-tests.md rename to docs/docs/best-practices/writing-tests.md diff --git a/documentation/docsify/sidebar.md b/docs/docsify/sidebar.md similarity index 100% rename from documentation/docsify/sidebar.md rename to docs/docsify/sidebar.md diff --git a/documentation/examples/README.md b/docs/examples/README.md similarity index 100% rename from documentation/examples/README.md rename to docs/examples/README.md diff --git a/documentation/examples/ca-fingerprint/index.js b/docs/examples/ca-fingerprint/index.js similarity index 100% rename from documentation/examples/ca-fingerprint/index.js rename to docs/examples/ca-fingerprint/index.js diff --git a/documentation/examples/eventsource.js b/docs/examples/eventsource.js similarity index 100% rename from documentation/examples/eventsource.js rename to docs/examples/eventsource.js diff --git a/documentation/examples/fetch.js b/docs/examples/fetch.js similarity index 100% rename from documentation/examples/fetch.js rename to docs/examples/fetch.js diff --git a/documentation/examples/proxy-agent.js b/docs/examples/proxy-agent.js similarity index 100% rename from documentation/examples/proxy-agent.js rename to docs/examples/proxy-agent.js diff --git a/documentation/examples/proxy/index.js b/docs/examples/proxy/index.js similarity index 100% rename from documentation/examples/proxy/index.js rename to docs/examples/proxy/index.js diff --git a/documentation/examples/proxy/proxy.js b/docs/examples/proxy/proxy.js similarity index 100% rename from documentation/examples/proxy/proxy.js rename to docs/examples/proxy/proxy.js diff --git a/documentation/examples/proxy/websocket.js b/docs/examples/proxy/websocket.js similarity index 100% rename from documentation/examples/proxy/websocket.js rename to docs/examples/proxy/websocket.js diff --git a/documentation/examples/request.js b/docs/examples/request.js similarity index 100% rename from documentation/examples/request.js rename to docs/examples/request.js diff --git a/documentation/index.html b/docs/index.html similarity index 100% rename from documentation/index.html rename to docs/index.html diff --git a/documentation/package.json b/docs/package.json similarity index 100% rename from documentation/package.json rename to docs/package.json diff --git a/package.json b/package.json index 47c7000480c..748b8098ca0 100644 --- 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 index 5603cb3faaf..e06b2d4ddb8 100644 --- 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 })