From 383dc07dad346af1a241bb7e2865ae625ddd7c61 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Fri, 4 Feb 2022 17:59:33 +0100 Subject: [PATCH] chore: fix broken links and help text (#4043) * chore: fix broken links * chore: fix link * chore: remove redundant link from readme * chore: remode dead link from readme --- README.md | 8 +++----- docs/BROWSERS.md | 4 ++-- docs/DELEGATE_ROUTERS.md | 2 +- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7234af695d..6e426be872 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,8 @@ We've come a long way, but this project is still in Alpha, lots of development i * Ensure CORS is [correctly configured](https://github.com/ipfs/js-ipfs/blob/master/docs/CORS.md) for use with the HTTP client * Look into the [examples](https://github.com/ipfs-examples/js-ipfs-examples/tree/master) to learn how to spawn an IPFS node in Node.js and in the Browser * Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node -* Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it -* Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs -* Check out https://docs.ipfs.io for tips, how-tos and more +* Head over to https://proto.school to take the [IPFS course](https://proto.school/course/ipfs) that covers core IPFS concepts and JS APIs +* Check out https://docs.ipfs.io for [glossary](https://docs.ipfs.io/concepts/glossary), tips, how-tos and more * See https://blog.ipfs.io for news and more * Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io @@ -113,10 +112,9 @@ This project is broken into several modules, their purposes are: * [`/packages/ipfs-grpc-protocol`](./packages/ipfs-grpc-protocol) Shared module between the gRPC client and server * [`/packages/ipfs-grpc-server`](./packages/ipfs-grpc-server) A gRPC-over-websockets server for js-IPFS * [`/packages/ipfs-http-client`](./packages/ipfs-http-client) A client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs +* [`/packages/ipfs-http-server`](./packages/ipfs-http-server) JS implementation of the [IPFS RPC HTTP API](https://docs.ipfs.io/reference/http/api/) * [`/packages/ipfs-http-gateway`](./packages/ipfs-http-gateway) JS implementation of the [IPFS HTTP Gateway](https://docs.ipfs.io/concepts/ipfs-gateway/) * [`/packages/ipfs-http-response`](./packages/ipfs-http-response) Creates a HTTP response for a given IPFS Path -* [`/packages/ipfs-http-server`](./packages/ipfs-http-server) JS implementation of the [IPFS HTTP API](https://docs.ipfs.io/reference/http/api/) -* [`/packages/ipfs-message-port-client`](./packages/ipfs-http-client) A client for the RPC-over-HTTP API presented by both js-ipfs and go-ipfs * [`/packages/ipfs-message-port-client`](./packages/ipfs-message-port-client) A client for the RPC-over-message-port API presented by js-ipfs running in a shared worker * [`/packages/ipfs-message-port-protocol`](./packages/ipfs-message-port-protocol) Code shared by the message port client & server * [`/packages/ipfs-message-port-server`](./packages/ipfs-message-port-server) The server that receives requests from ipfs-message-port-client diff --git a/docs/BROWSERS.md b/docs/BROWSERS.md index cffebd8070..25708df1d8 100644 --- a/docs/BROWSERS.md +++ b/docs/BROWSERS.md @@ -54,8 +54,8 @@ You can find detailed information about running js-ipfs [here](https://github.co The default ones are under high load and should be used only for tests and development. - Make sure content added to js-ipfs running in the browser is persisted/cached somewhere on regular IPFS daemon - Manually `pin` or preload CIDs of interest with `refs -r` beforehand. - - Preload content on the fly using [preload](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/MODULE.md#optionspreload) feature and/or - configure [delegated routing](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/DELEGATE_ROUTERS.md). + - Preload content on the fly using [preload](https://github.com/ipfs/js-ipfs/blob/master/docs/MODULE.md#optionspreload) feature and/or + configure [delegated routing](https://github.com/ipfs/js-ipfs/blob/master/docs/DELEGATE_ROUTERS.md). - Avoid public instances in production environment. Make sure preload and delegate nodes used in config are self-hosted and under your control (expose a subset of go-ipfs APIs via reverse proxy such as Nginx). ## Code Examples diff --git a/docs/DELEGATE_ROUTERS.md b/docs/DELEGATE_ROUTERS.md index da68539ddf..03b906a6c0 100644 --- a/docs/DELEGATE_ROUTERS.md +++ b/docs/DELEGATE_ROUTERS.md @@ -24,7 +24,7 @@ Available delegate multiaddrs are: **Note**: If more than 1 delegate multiaddr is specified, the actual delegate will be randomly selected on startup. -**Note**: If you wish to use delegated routing and are creating your node _programmatically_ in Node.js or the browser you must `npm install libp2p-delegated-content-routing` and/or `npm install libp2p-delegated-peer-routing` and provide configured instances of them in [`options.libp2p`](#optionslibp2p). See the module repos for further instructions: +**Note**: If you wish to use delegated routing and are creating your node _programmatically_ in Node.js or the browser you must `npm install libp2p-delegated-content-routing` and/or `npm install libp2p-delegated-peer-routing` and provide configured instances of them in [`options.libp2p`](./MODULE.md#optionslibp2p). See the module repos for further instructions: - https://github.com/libp2p/js-libp2p-delegated-content-routing - https://github.com/libp2p/js-libp2p-delegated-peer-routing