Skip to content

Commit

Permalink
Cleanup js-ipfs mentions (#1620)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
5 people authored Jul 14, 2023
1 parent 8b4134a commit cb9e234
Show file tree
Hide file tree
Showing 20 changed files with 67 additions and 1,580 deletions.
3 changes: 0 additions & 3 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,6 @@ module.exports = {
collapsable: true,
children: [
'/how-to/observe-peers',
'/how-to/exchange-files-between-nodes',
'/how-to/peering-with-content-providers'
]
},
Expand All @@ -243,7 +242,6 @@ module.exports = {
collapsable: true,
children: [
'/how-to/address-ipfs-on-web',
'/how-to/create-simple-chat-app',
'/how-to/browser-tools-frameworks'
]
},
Expand Down Expand Up @@ -280,7 +278,6 @@ module.exports = {
sidebarDepth: 1,
collapsable: true,
children: [
'/how-to/mint-nfts-with-ipfs',
'/how-to/best-practices-for-nft-data'
]
},
Expand Down
19 changes: 17 additions & 2 deletions docs/concepts/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ description: Explore frequently asked questions about IPFS, the InterPlanetary F

## What is IPFS?

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.
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.

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

## IPFS in action

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

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)

### What is an implementation

An IPFS implementation is any software with basic functionality for interaction with other IPFS implementations. An implementation:

- Supports addressability using CIDs.

- 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.

- 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.

There are already many IPFS implementations, including [Kubo](../install/command-line.md), [Helia](../install/js-ipfs.md), and [more](../concepts/ipfs-implementations.md).

You can also create your own IPFS implementation.

## IPFS and Filecoin

### What is the connection between IPFS and Filecoin?
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/file-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ await ipfs.files.rm('/my/beautiful/directory')

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.

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:
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:

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

Expand Down
10 changes: 7 additions & 3 deletions docs/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@ The sharding technique used for [sharding](#sharding) big UnixFS directories. It

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)

### Helia

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).

### Hole punching

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

### JS-IPFS

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)
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).

### JSON

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

### Multihash

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/).
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).

### Multiformats

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/)
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)

## N

Expand Down
6 changes: 1 addition & 5 deletions docs/concepts/ipns.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ The main implication of this difference is that IPNS operations (publishing and
#### IPNS over the DHT

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

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.

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

For example:

- [https://ipfs.io/ipns/k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8](https://ipfs.io/ipns/k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8)

> **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.
<!-- ### Third-party providing/publishing w3name -->
Expand Down
Loading

0 comments on commit cb9e234

Please sign in to comment.