From b8baf2f487b87fe78a44053aa614f4a7a6c89481 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Fri, 1 Dec 2023 01:09:26 +0100 Subject: [PATCH] chore: markdown lint --- .github/styles/pln-ignore.txt | 1 + docs/reference/kubo/cli.md | 4 ++-- docs/reference/kubo/generate-cli-docs.sh | 4 ++-- docs/reference/kubo/rpc.md | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/styles/pln-ignore.txt b/.github/styles/pln-ignore.txt index 5833624bc..4aa3e1050 100644 --- a/.github/styles/pln-ignore.txt +++ b/.github/styles/pln-ignore.txt @@ -12,6 +12,7 @@ Arbol's auditable Audius auspinner +autogenerated BitSwap bitswap Blockchain diff --git a/docs/reference/kubo/cli.md b/docs/reference/kubo/cli.md index abef76be6..cdd4611df 100644 --- a/docs/reference/kubo/cli.md +++ b/docs/reference/kubo/cli.md @@ -14,13 +14,13 @@ For issues and support, check out the [generate-cli-docs.sh](https://github.com/ IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online. -The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online. +The [command-line quickstart guide](../../how-to/command-line-quick-start.md) explains how to start the IPFS daemon and take your node online. ### Alignment with Kubo RPC API -Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example: +Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example: ```sh > ipfs swarm peers diff --git a/docs/reference/kubo/generate-cli-docs.sh b/docs/reference/kubo/generate-cli-docs.sh index 8cbdc7fad..eef229ba9 100755 --- a/docs/reference/kubo/generate-cli-docs.sh +++ b/docs/reference/kubo/generate-cli-docs.sh @@ -21,14 +21,14 @@ For issues and support, check out the [generate-cli-docs.sh](https://github.com/ IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like \`ipfs swarm peers\`, are only supported when online. -The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online. +The [command-line quickstart guide](../..//how-to/command-line-quick-start.md) explains how to start the IPFS daemon and take your node online. " echo " ### Alignment with Kubo RPC API -Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example: +Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example: \`\`\`sh > ipfs swarm peers diff --git a/docs/reference/kubo/rpc.md b/docs/reference/kubo/rpc.md index a985c2b99..bfba64479 100644 --- a/docs/reference/kubo/rpc.md +++ b/docs/reference/kubo/rpc.md @@ -2313,7 +2313,7 @@ Resolve IPNS names. - `recursive` [bool]: Resolve until the result is not an IPNS name. Default: `true`. Required: no. - `nocache` [bool]: Do not use cached entries. Required: no. - `dht-record-count` [uint]: Number of records to request for DHT resolution. Default: `16`. Required: no. -- `dht-timeout` [string]: Max time to collect values during DHT resolution eg "30s". Pass 0 for no timeout. Default: `1m0s`. Required: no. +- `dht-timeout` [string]: Max time to collect values during DHT resolution e.g. "30s". Pass 0 for no timeout. Default: `1m0s`. Required: no. - `stream` [bool]: Stream entries as they are found. Required: no.