Skip to content

Commit cb9e234

Browse files
ElPaisanoSgtPookilidelwhizzzkidBigLep
authored
Cleanup js-ipfs mentions (#1620)
Removes various js-ipfs legacy docs items Co-authored-by: Russell Dempsey <[email protected]> Co-authored-by: Marcin Rataj <[email protected]> Co-authored-by: Nishant Arora <[email protected]> Co-authored-by: Steve Loeppky <[email protected]>
1 parent 8b4134a commit cb9e234

20 files changed

+67
-1580
lines changed

Diff for: docs/.vuepress/config.js

-3
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,6 @@ module.exports = {
220220
collapsable: true,
221221
children: [
222222
'/how-to/observe-peers',
223-
'/how-to/exchange-files-between-nodes',
224223
'/how-to/peering-with-content-providers'
225224
]
226225
},
@@ -243,7 +242,6 @@ module.exports = {
243242
collapsable: true,
244243
children: [
245244
'/how-to/address-ipfs-on-web',
246-
'/how-to/create-simple-chat-app',
247245
'/how-to/browser-tools-frameworks'
248246
]
249247
},
@@ -280,7 +278,6 @@ module.exports = {
280278
sidebarDepth: 1,
281279
collapsable: true,
282280
children: [
283-
'/how-to/mint-nfts-with-ipfs',
284281
'/how-to/best-practices-for-nft-data'
285282
]
286283
},

Diff for: docs/concepts/faq.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ description: Explore frequently asked questions about IPFS, the InterPlanetary F
77

88
## What is IPFS?
99

10-
IPFS stands for the InterPlanetary File System — a peer-to-peer network for storing and accessing files, websites, applications, and data in a distributed file system.
10+
The InterPlanetary File System (IPFS) is a set of composable, peer-to-peer protocols for addressing, routing, and transferring [content-addressed](../concepts/glossary.md#content-addressing) data in a decentralized file system. Many popular Web3 projects are built on IPFS - see the [ecosystem directory](https://ecosystem.ipfs.tech) for a list of some of these projects.
1111

12-
To learn more, see the ["What is IPFS?"](what-is-ipfs.md) guide.
12+
New to IPFS? Start with
13+
[the 3-page Basic Concepts](../concepts/README.md#learn-the-basics).
1314

1415
## IPFS in action
1516

@@ -34,6 +35,20 @@ When you add a file to IPFS, IPFS splits it into smaller blocks. IPFS hashes eac
3435

3536
There are a lot of ways you can contribute to IPFS, whether you're interested in helping with either of the core implementations, applications like IPFS Desktop, writing or editing documentation, doing UX, or whatever you enjoy working on. [Get all the details on where to get started here.](../community/contribute/ways-to-contribute.md)
3637

38+
### What is an implementation
39+
40+
An IPFS implementation is any software with basic functionality for interaction with other IPFS implementations. An implementation:
41+
42+
- Supports addressability using CIDs.
43+
44+
- Exposes operations like retrieval, provisioning and indexing on resources using CIDs. The operations that an implementation may support are open-ended, but this requirement should cover any interaction which the implementation exposes to other IPFS implementations.
45+
46+
- Verifies that the CIDs it resolves match the resources they address, at least when it has access to the resources bytes. However, implementations may relax this requirement in controlled environments in which it is possible to ascertain that verification has happened elsewhere in a trusted part of the system.
47+
48+
There are already many IPFS implementations, including [Kubo](../install/command-line.md), [Helia](../install/js-ipfs.md), and [more](../concepts/ipfs-implementations.md).
49+
50+
You can also create your own IPFS implementation.
51+
3752
## IPFS and Filecoin
3853

3954
### What is the connection between IPFS and Filecoin?

Diff for: docs/concepts/file-systems.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ await ipfs.files.rm('/my/beautiful/directory')
219219

220220
When you add a _file_ to IPFS, it might be too big to fit in a single block, so it needs metadata to link all its blocks together. UnixFS is a [protocol-buffers](https://developers.google.com/protocol-buffers/)-based format for describing files, directories, and symlinks in IPFS. This data format is used to represent files and all their links and metadata in IPFS. UnixFS creates a block (or a tree of blocks) of linked objects.
221221

222-
UnixFS currently has [Javascript](https://github.com/ipfs/js-ipfs-unixfs) and [Go](https://github.com/ipfs/kubo/tree/b3faaad1310bcc32dc3dd24e1919e9edf51edba8/unixfs) implementations. These implementations have modules written in to run different functions:
222+
UnixFS currently has [Javascript](https://github.com/ipfs/helia-unixfs) and [Go](https://github.com/ipfs/kubo/tree/b3faaad1310bcc32dc3dd24e1919e9edf51edba8/unixfs) implementations. These implementations have modules written in to run different functions:
223223

224224
- **Data Formats**: manage the serialization/deserialization of UnixFS objects to protocol buffers
225225

Diff for: docs/concepts/glossary.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,10 @@ The sharding technique used for [sharding](#sharding) big UnixFS directories. It
228228

229229
A Cryptographic Hash is a function that takes some arbitrary input (content) and returns a fixed-length value. The exact same input data will always generate the same hash as output. There are numerous hash algorithms. [More about Hash](hashing.md)
230230

231+
### Helia
232+
233+
A lean, modular, and modern implementation of IPFS for the JS and browser environments. Superseded [js-ipfs](#js-ipfs). Learn more at [https://github.com/ipfs/helia](https://github.com/ipfs/helia).
234+
231235
### Hole punching
232236

233237
A technique for [NAT](#nat) or firewall traversal that relies on coordinated simultaneous connections. Used when port forwarding is not possible. [See DCUtR](#dcutr)
@@ -250,7 +254,7 @@ The InterPlanetary Name System (IPNS) is a system for creating and updating muta
250254

251255
### JS-IPFS
252256

253-
An implementation of IPFS written entirely in JavaScript. It runs in a Browser, a Service Worker, Electron and Node.js. See [Nodes > JS-IPFS](../concepts/nodes.md#js-ipfs)
257+
An [implementation of IPFS written entirely in JavaScript](https://github.com/ipfs/js-ipfs). It runs in a browser, a service worker, Electron and Node.js. Deprecated and superseded by [Helia](#helia).
254258

255259
### JSON
256260

@@ -316,11 +320,11 @@ Multicodec is an identifier indicating the format of the target content. It help
316320

317321
### Multihash
318322

319-
Multihash is a protocol for differentiating outputs from various well-established hash functions, addressing size and encoding considerations. It is useful to write applications that future-proof their use of hashes, and it allows multiple hash functions to coexist. [More about Multihash](https://multiformats.io/multihash/).
323+
Multihash is a protocol for differentiating outputs from various well-established hash functions, addressing size and encoding considerations. It is useful to write applications that future-proof their use of hashes, and it allows multiple hash functions to coexist. [More about Multihash](https://github.com/multiformats/multihash).
320324

321325
### Multiformats
322326

323-
The Multiformats project is a collection of protocols that aim to future-proof systems today. A key element is enhancing format values with self-description. This allows for interoperability, protocol agility, and promotes extensibility. [More about Multiformats](https://multiformats.io/) and [Multihash](https://multiformats.io/multihash/)
327+
The Multiformats project is a collection of protocols that aim to future-proof systems today. A key element is enhancing format values with self-description. This allows for interoperability, protocol agility, and promotes extensibility. [More about Multiformats](https://multiformats.io/) and [Multihash](https://github.com/multiformats/multihash)
324328

325329
## N
326330

Diff for: docs/concepts/ipns.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The main implication of this difference is that IPNS operations (publishing and
117117
118118
#### IPNS over the DHT
119119

120-
The DHT is the default transport mechanism for IPNS records in most IPFS implementations, e.g. Kubo, and js-ipfs.
120+
The DHT is the default transport mechanism for IPNS records in many IPFS implementations.
121121

122122
Due to the ephemeral nature of the DHT, peers forget records after 24 hours. This applies to any record in the DHT, irrespective of the `validity` (also referred to as `lifetime`) field in the IPNS record.
123123

@@ -191,10 +191,6 @@ IPNS names can be resolved by [IPFS gateways](ipfs-gateway.md) in a _trusted_ fa
191191
- Path resolution: `https://ipfs.io/ipns/{ipns-name}`
192192
- Subdomain resolution: `https://{ipns-name}.ipns.dweb.link`
193193

194-
For example:
195-
196-
- [https://ipfs.io/ipns/k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8](https://ipfs.io/ipns/k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8)
197-
198194
> **Note** IPNS resolution via an IPFS gateway is **trusted** (in the sense of trusting the gateway) which means you delegate IPNS resolution to the gateway without any means to verify the authenticity response you get, i.e the content path and signature of the IPNS record.
199195
200196
<!-- ### Third-party providing/publishing w3name -->

0 commit comments

Comments
 (0)