Skip to content

Commit bf7c9ce

Browse files
committed
small refinements
1 parent 5c912db commit bf7c9ce

File tree

2 files changed

+23
-22
lines changed

2 files changed

+23
-22
lines changed

docs/quickstart/publish.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ The web3.storage pinning service was chosen purely for demonstration purposes, a
1313

1414
## Contents <!-- omit from toc -->
1515

16-
- [Pinning overview](#overview)
16+
- [Overview](#overview)
17+
- [Pinning services](#pinning-services)
1718
- [Prerequisites](#prerequisites)
1819
- [Uploading and pinning a file](#uploading-and-pinning-a-file)
1920
- [CIDs explained](#cids-explained)
21+
- [Retrieving with a gateway](#retrieving-with-a-gateway)
2022
- [Summary and next steps](#summary-and-next-steps)
2123

2224
## Overview
@@ -25,7 +27,7 @@ _Pinning_ refers to the process of ensuring that a particular piece of content i
2527

2628
Pinning can be done at various levels, from individual files to entire directories that are addressed by a CID. You can also pin CIDs to multiple IPFS nodes to increase the redundancy and resilience of the file on the network.
2729

28-
### Pinning services
30+
## Pinning services
2931

3032
[Pinning services](../concepts/persistence.md#pinning-services) are similar to hosting services, in that they run an IPFS node for you and ensure that your files are available to the IPFS network.
3133

@@ -40,7 +42,7 @@ Data pinned to the IPFS network is public by default and retrievable by anyone.
4042

4143
![image](../quickstart/images/welcome-to-IPFS.jpg)
4244

43-
## Uploading and pinning a file
45+
## Upload and pin a file
4446

4547
1. Sign into your account on web3.storage.
4648

docs/quickstart/retrieve.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ You will fetch the image that was pinned in the [publishing with a pinning servi
1313
The CID you will retrieve is actually a folder containing a single image file. The reason for this that when files are added to IPFS, the filename is not stored by default. To retain the filename, it's a common practice to wrap the file in a directory. In such instances, you end up with two CIDs - one for the file and another for the directory containing the file.
1414
:::
1515

16-
## Contents
16+
## Contents <!-- omit from toc -->
1717

18-
- [Retrieving a CID with IPFS](#retrieving-a-cid-with-ipfs)
1918
- [IPFS retrieval methods](#ipfs-retrieval-methods)
2019
- [Verified vs. trusted CID retrieval](#verified-vs-trusted-cid-retrieval)
2120
- [Fetching the CID with Kubo](#fetching-the-cid-with-kubo)
@@ -49,29 +48,29 @@ To fetch the CID with [Kubo](../install/command-line.md), complete the steps bel
4948

5049
1. Ensure that the Kubo daemon is installed and running:
5150

52-
```bash
53-
$ ipfs daemon
54-
```
51+
```bash
52+
$ ipfs daemon
53+
```
5554

5655
2. To fetch the file, run the [`ipfs get [CID]`](../reference/kubo/cli.md#ipfs-get) command:
5756

58-
```bash
59-
$ ipfs get bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4
60-
```
57+
```bash
58+
$ ipfs get bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4
59+
```
6160

62-
The output should look as follows:
61+
The output should look as follows:
6362

64-
```bash
65-
Saving file(s) to bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4
66-
647.61 KiB / 647.61 KiB [========================================================================================================================] 100.00% 0s
67-
```
63+
```bash
64+
Saving file(s) to bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4
65+
647.61 KiB / 647.61 KiB [========================================================================================================================] 100.00% 0s
66+
```
6867

69-
A new folder with the same name as the CID was created:
68+
A new folder with the same name as the CID was created:
7069

71-
```bash
72-
$ ls bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4/
73-
welcome-to-IPFS.jpg
74-
```
70+
```bash
71+
$ ls bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4/
72+
welcome-to-IPFS.jpg
73+
```
7574

7675
Congratulations, you have successfully fetched the CID.
7776

@@ -91,4 +90,4 @@ You then fetched the image that was pinned in the [publishing with a pinning ser
9190

9291
Possible next steps include:
9392

94-
- Learn more about [how IPFS works](../concepts/how-ipfs-works.md) and [the lifecycle of data in IPFS](../concepts/lifecycle.md).
93+
- Learn more about [how IPFS works](../concepts/how-ipfs-works.md) and [the lifecycle of data in IPFS](../concepts/lifecycle.md).

0 commit comments

Comments
 (0)