Skip to content

Commit 7dd0675

Browse files
authored
Concepts overhaul
*Rewrite basic concepts down to 3 pages *Add tooltips *General overhaul of concepts Co-authored with @2color
1 parent c7be5b7 commit 7dd0675

21 files changed

+512
-377
lines changed

.github/styles/Vocab/ipfs-docs-vocab/accept.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
[Mm]ulticodec
4444
[Mm]ultiformats
4545
[Mm]ultihash
46+
[Mm]ulticast
4647
[Nn]amespace
4748
[Pp]reload
4849
[Pp]ub[Ss]ub
@@ -66,6 +67,7 @@ Browserify
6667
callouts?
6768
CAs?
6869
CDNs?
70+
CIDs
6971
Certbot
7072
CNAMEs?
7173
codec
@@ -136,6 +138,8 @@ Metamask
136138
Minty('s)?
137139
Mojitos
138140
multipage
141+
multihashes
142+
multihash
139143
Nagaraj
140144
Nakamoto('s)?
141145
Namebase
@@ -203,3 +207,14 @@ whitepaper
203207
WiFi
204208
WS
205209
^WSS$
210+
youtube
211+
upgradeability
212+
wantlists
213+
requesters
214+
[Ss]neakernet
215+
Sneakernets
216+
upgradeability
217+
performant
218+
sneakernet
219+
Sneakernet
220+
Bitswap

docs/.vuepress/config.js

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,25 +99,33 @@ module.exports = {
9999
],
100100
'/concepts/': [
101101
{
102-
title: 'Basic Concepts',
102+
title: 'Basics',
103103
sidebarDepth: 1,
104104
collapsable: true,
105105
children: [
106106
'/concepts/what-is-ipfs',
107+
'/concepts/ipfs-solves',
107108
'/concepts/how-ipfs-works',
108-
'/concepts/content-addressing',
109+
]
110+
},
111+
{
112+
title: 'Ideas and theory',
113+
sidebarDepth: 1,
114+
collapsable: true,
115+
children: [
109116
'/concepts/hashing',
110117
'/concepts/immutability',
111118
'/concepts/persistence',
112119
'/concepts/privacy-and-encryption',
113-
'/concepts/nodes'
120+
'/concepts/nodes',
114121
]
115122
},
116123
{
117-
title: 'Subsystems and Components',
124+
title: 'Subsystems and components',
118125
sidebarDepth: 1,
119126
collapsable: true,
120127
children: [
128+
'/concepts/content-addressing',
121129
'/concepts/bitswap',
122130
'/concepts/dht',
123131
'/concepts/dnslink',
@@ -154,8 +162,8 @@ module.exports = {
154162
'https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/custom-ipfs-repo',
155163
'Customize an IPFS repo'
156164
],
157-
'/how-to/best-practices-for-ipfs-builders',
158-
'/how-to/troubleshooting'
165+
'/how-to/kubo-garbage-collection',
166+
'/how-to/troubleshooting',
159167
]
160168
},
161169
{
@@ -169,7 +177,7 @@ module.exports = {
169177
'/how-to/take-snapshot',
170178
'/how-to/store-play-videos',
171179
'/how-to/host-git-repo',
172-
'/how-to/move-ipfs-installation/move-ipfs-installation'
180+
'/how-to/move-ipfs-installation/move-ipfs-installation',
173181
]
174182
},
175183
{
@@ -230,7 +238,15 @@ module.exports = {
230238
collapsable: true,
231239
children: [
232240
'/how-to/mint-nfts-with-ipfs',
233-
'/how-to/best-practices-for-nft-data'
241+
'/how-to/best-practices-for-nft-data'
242+
]
243+
},
244+
{
245+
title: 'Privacy and Encryption',
246+
sidebarDepth: 1,
247+
collapsable: true,
248+
children: [
249+
['/how-to/privacy-best-practices', 'Privacy and Encryption'],
234250
]
235251
}
236252
],
@@ -342,6 +358,7 @@ module.exports = {
342358
plugins: [
343359
[require('./plugins/vuepress-plugin-speedcurve'), { id: SPEEDCURVE_ID }],
344360
'@vuepress/plugin-back-to-top',
361+
['@adamdehaven/vuepress-plugin-custom-tooltip'],
345362
[
346363
'@vuepress/google-analytics',
347364
{

docs/.vuepress/redirects

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/basics/desktop-app /how-to/desktop-app
2-
/basics/go/ /install/command-line
3-
/basics/go/command-line /how-to/kubo-basic-cli
2+
/basics/go/command-line-quick-start /how-to/command-line-quick-start
3+
/basics/concepts /concepts
44
/basics/js/js-ipfs /install/js-ipfs
55
/basics/ipfs-implementations /concepts/ipfs-implementations
66
/community/chat /community

docs/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ While IPFS is a file system, it is _not_ a storage system. Instead, IPFS can be
1313

1414
Check out these docs to get started with IPFS:
1515

16-
- [What is IPFS?](concepts/what-is-ipfs.md#what-is-ipfs)
17-
- [Key concepts](concepts/README.md)
16+
- [Learn the basics](concepts/README.md#learn-the-basics)
1817
- [Case studies](concepts/README.md#examples-and-case-studies)
1918
- [How-to guides](how-to/README.md)
2019
- [API and CLI references](reference/README.md)
@@ -41,7 +40,7 @@ Protect yourself from single-point-of-failure risks and benefit from decentraliz
4140

4241
Want to know more about the decentralized web (DWeb) and how it's changing the internet? These resources will give you a clearer understanding of the DWeb movement, and how it's improving the world:
4342

44-
- [What is IPFS](concepts/what-is-ipfs.md)
43+
- [IPFS and the problems it solves](concepts/what-is-ipfs.md)
4544
- [Peer-to-peer sharing](concepts/dht.md)
4645
- [Content-addressed data](concepts/content-addressing.md)
4746

docs/concepts/README.md

Lines changed: 54 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -3,83 +3,84 @@ title: Concepts
33
description: Get started on understanding the key ingredients in the decentralized web and how IPFS works.
44
---
55

6-
# IPFS concepts
6+
# Concepts
77

8-
New to IPFS or the distributed web? Here's where to get started on understanding the key ingredients in what makes IPFS work. Because IPFS is a system that hopes to change how we use the Internet, it comes with many new concepts! This section aims to get you up to speed quickly.
8+
Welcome to the Concepts section of the InterPlanetary File System (IPFS) docs. Here, you can:
99

10-
## Video overviews
11-
12-
Want the basics in theater mode? Check out these helpful videos for an overview of how IPFS works with files and the overall data lifecycle in the d-web.
13-
14-
@[youtube](Z5zNPwMDYGg)
10+
- Learn what IPFS is and isn't, the problems it solves, the different subsystems that it is comprised of and how each one works in [the 3-page Basic Concepts](#learn-the-basics).
11+
- Dive into ideas like hashing, immutability, persistence (and more) that underlie IPFS in [Ideas and theory](#ideas-and-theory)
12+
- Learn more about the subsystems that IPFS is comprised of in [Subsystems and components](#subsystems-and-components)
13+
- Get an [overview of IPFS implementations](../concepts/ipfs-implementations.md).
14+
- [Compare IPFS to other similar systems](../concepts/comparisons.md).
15+
- Get answers to common questions about IPFS in [the FAQ](../concepts/faq.md).
16+
- Reference [the glossary of terms used in the IPFS ecosystem](../concepts/glossary.md).
17+
- Read [academic papers written about IPFS, including the original IPFS whitepaper](../concepts/further-reading/academic-papers.md).
18+
- Get inspired with [IPFS usage ideas and examples](#examples-and-case-studies).
19+
- Learn about IPFS in theater mode with [these helpful videos](#video-overviews).
1520

16-
- [Understanding how IPFS deals with files (IPFS Camp 2019)](https://youtu.be/Z5zNPwMDYGg)
17-
18-
@[youtube](fLUq0RkiTBA)
21+
:::callout
22+
### Don't see what you're looking for?
1923

20-
- [The lifecycle of data in the DWeb (IPFS Camp 2019)](https://youtu.be/fLUq0RkiTBA)
24+
We're adding more documentation all the time and making ongoing revisions to existing docs, but if you don't see what you need, please [file an issue](https://github.com/ipfs/ipfs-docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=content-request.md&title=%5BCONTENT+REQUEST%5D+%28add+your+title+here%21%29) to let us know! We also recommend visiting the [IPFS forums](https://discuss.ipfs.tech/) for support and discussion with IPFS enthusiasts and experts worldwide.
25+
:::
2126

22-
@[youtube](J-drqD2UebM)
27+
## Learn the basics
2328

24-
- [IPFS: A Whiteboard Overview](https://www.youtube.com/watch?v=J-drqD2UebM)
29+
1. [What IPFS is and isn't](../concepts/what-is-ipfs.md)
30+
1. [IPFS and the problems it solves](../concepts/ipfs-solves.md)
31+
1. [How IPFS works](../concepts/how-ipfs-works.md)
2532

26-
Check out ResNetLab on Tour for complete tutorials on IPFS and the Web 3.0 stack:
33+
## Ideas and theory
2734

28-
- [ResNetLab on Tour 2021](https://research.protocol.ai/tutorials/resnetlab-on-tour/)
29-
30-
## IPFS 101
35+
- [Cryptographic hashing](hashing.md)
36+
- [Immutability](immutability.md)
37+
- [Persistence, permanence and pinning](persistence.md)
38+
- [Privacy and encryption](privacy-and-encryption.md)
39+
- [Nodes](nodes.md)
3140

32-
Get the basic concepts of IPFS in one place, including:
41+
## Subsystems and components
3342

34-
- [What is IPFS?](what-is-ipfs.md)
35-
- [How IPFS works](how-ipfs-works.md)
36-
- [Glossary](glossary.md)
37-
- [FAQ](faq.md)
43+
- [Content Identifiers (CIDs)](content-addressing.md)
44+
- [Bitswap](bitswap.md)
45+
- [Distributed Hash Tables (DHTs)](dht.md)
46+
- [DNSLink](dnslink.md)
47+
- [File systems](file-systems.md)
48+
- [IPFS Gateway](ipfs-gateway.md)
49+
- [IPLD](ipld.md)
50+
- [IPNS](ipns.md)
51+
- [libp2p](libp2p.md)
52+
- [Merkle Directed Acyclic Graphs (DAGs)](merkle-dag.md)
3853

3954
## Examples and case studies
4055

41-
Get inspired by usage ideas, explore examples of IPFS implemented in the wild, and dig deeper with case studies on applications and projects in which IPFS plays a crucial role.
42-
4356
- [Usage ideas & examples](usage-ideas-examples.md)
44-
- [Case study: Arbol](case-study-arbol.md)
45-
- [Case study: Audius](case-study-audius.md)
46-
- [Case study: Fleek](case-study-fleek.md)
47-
- [Case study: LikeCoin](case-study-likecoin.md)
48-
- [Case study: Morpheus.Network](case-study-morpheus.md)
49-
- [Case study: Snapshot](case-study-snapshot.md)
57+
- [Case study: Arbol](../case-studies/arbol.md)
58+
- [Case study: Audius](../case-studies/audius.md)
59+
- [Case study: Fleek](../case-studies/fleek.md)
60+
- [Case study: LikeCoin](../case-studies/likecoin.md)
61+
- [Case study: Morpheus.Network](../case-studies/morpheus.md)
62+
- [Case study: Snapshot](../case-studies/snapshot.md)
5063

51-
## Content-addressed storage
64+
## Video overviews
5265

53-
Referring to files by their content, not their location, is one of the most powerful concepts within IPFS. Learn why with explainers on:
66+
<!-- markdown-link-check-disable -->
67+
@[youtube](Z5zNPwMDYGg)
5468

55-
- [Content addressing](content-addressing.md)
56-
- [Cryptographic hashing](hashing.md)
57-
- [Immutability](immutability.md)
58-
- [Persistence, permanence and pinning](persistence.md)
69+
- [Understanding how IPFS deals with files (IPFS Camp 2019)](https://youtu.be/Z5zNPwMDYGg)
5970

60-
## Peer-to-peer file sharing
71+
@[youtube](fLUq0RkiTBA)
6172

62-
Sharing files between peers is incredibly powerful — and has many nuances! Learn about file-sharing paradigms and tools:
73+
- [The lifecycle of data in the DWeb (IPFS Camp 2019)](https://youtu.be/fLUq0RkiTBA)
6374

64-
- [Distributed Hash Tables (DHTs)](dht.md)
65-
- [Merkle DAGs](merkle-dag.md)
66-
- [Bitswap](bitswap.md)
67-
- [IPLD](ipld.md)
68-
- [IPNS](ipns.md)
69-
- [libp2p](libp2p.md)
70-
- [File systems](file-systems.md)
75+
@[youtube](J-drqD2UebM)
7176

72-
## Integrating IPFS and the existing Web
77+
- [IPFS: A Whiteboard Overview](https://www.youtube.com/watch?v=J-drqD2UebM)
78+
<!-- markdown-link-check-enable-->
79+
Check out ResNetLab on Tour for complete tutorials on IPFS and the Web 3.0 stack:
7380

74-
IPFS aims to be the future of the internet, but it still needs to play well with today's Web. Here are some ways to do just that:
81+
- [ResNetLab on Tour 2021](https://research.protocol.ai/tutorials/resnetlab-on-tour/)
7582

76-
- [IPFS Gateway](ipfs-gateway.md)
77-
- [DNSLink](dnslink.md)
7883

7984
## Further reading
8085

8186
Want a more in-depth look into the decentralized web? Here are a few papers that are useful for understanding IPFS, whether it be understanding the IPFS spec itself or the background for the web, protocols, hashing, and so on. [Read the papers →](further-reading/academic-papers.md)
82-
83-
## Don't see what you're looking for?
84-
85-
We're adding more documentation all the time and making ongoing revisions to existing docs, but if you don't see what you need, please [file an issue](https://github.com/ipfs/ipfs-docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=content-request.md&title=%5BCONTENT+REQUEST%5D+%28add+your+title+here%21%29) to let us know! We also recommend visiting the [IPFS forums](https://discuss.ipfs.tech/) for support and discussion with IPFS enthusiasts and experts worldwide.

docs/concepts/comparisons.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
title: 'IPFS Comparisons'
2+
title: 'IPFS comparisons'
33
description: Comparing IPFS to other solutions.
44
---
55

6-
# IPFS Comparisons
7-
8-
## How is IPFS different from other solutions?
6+
# IPFS comparisons
97

108
IPFS is a general-purpose file system that uses a distributed hash table (DHT) to route and transfer content-addressed data. This sets it apart from other solutions with a more specific focus or use of a specific data storage mechanism. For example:
119

0 commit comments

Comments
 (0)