Skip to content

Commit 8be3dbe

Browse files
committed
docs: update links to current specs and mark historical docs
- update README.md to link to specs.ipfs.tech for UnixFS and Bitswap - update README.md to link to kubo repo for implementation-specific specs - clarify kubo-specific specs are implementation details - add historical context notes to legacy specs from ~2015 - mark ARCHITECTURE.md as historical (from ~2015) - fix IPNS Record Creation and Verification link
1 parent 1f086ce commit 8be3dbe

File tree

5 files changed

+19
-8
lines changed

5 files changed

+19
-8
lines changed

ARCHITECTURE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) IPFS Architecture Overview
22

3+
> [!NOTE]
4+
> This document contains historical notes about IPFS architecture from ~2015. For current specifications, please refer to https://specs.ipfs.tech/
35
46
**Authors(s)**:
57
- [Juan Benet](https://github.com/jbenet)

DWEB_ADDRESSING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) Addressing on the Decentralized Web
22

3+
> [!NOTE]
4+
> This is an incomplete work-in-progress document from the early days of IPFS. For current addressing specifications, please refer to https://specs.ipfs.tech/
5+
36
**Authors(s)**:
47
- [Lars Gierth](mailto:lgierth@ipfs.io)
58

IMPORTERS_EXPORTERS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) Data Importers & Exporters
22

3+
> [!NOTE]
4+
> This is a work-in-progress specification from the early days of IPFS. For current UnixFS and data import specifications, please refer to https://specs.ipfs.tech/unixfs/
5+
36
**Authors(s)**:
47
- David Dias
58
- Juan Benet

KEYCHAIN.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) The Keychain
22

3+
> [!NOTE]
4+
> This is a work-in-progress specification from the early days of IPFS that was never completed. It remains here for historical reference.
5+
36
**Authors(s)**:
47
- [Juan Benet](github.com/jbenet)
58

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The specs contained in this and related repositories are:
3535

3636
- **IPFS Protocol:**
3737
- [IPFS Guide](https://docs.ipfs.tech/) - to start your IPFS journey
38-
- [Protocol Architecture Overview](./ARCHITECTURE.md) - the top-level spec and the stack
38+
- [Protocol Architecture Overview (Historical Notes from ~2015)](./ARCHITECTURE.md) - the top-level spec and the stack
3939
- **User Interface (aka Public APIs):**
4040
- [HTTP Gateways](https://specs.ipfs.tech/http-gateways/) - implementation agnostic interfaces for accessing content-addressed data over HTTP
4141
- [Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) - implementation agnostic interfaces for content/peer/IPNS routing over HTTP
@@ -45,31 +45,31 @@ The specs contained in this and related repositories are:
4545
- [IPLD](https://ipld.io/specs/) - InterPlanetary Linked Data.
4646
- [DAG-CBOR](https://ipld.io/docs/codecs/known/dag-cbor/) - binary format, supporting the complete IPLD Data Model, with excellent performance, and suitable for any job.
4747
- [DAG-JSON](https://ipld.io/docs/codecs/known/dag-json/) - human-readable format, supporting almost the complete IPLD Data Model, and very convenient for interoperability, development, and debugging.
48-
- [DAG-PB](https://ipld.io/docs/codecs/known/dag-pb/) - a binary format for specific limited structures of data, which is highly used in IPFS and [UnixFS](./UNIXFS.md).
48+
- [DAG-PB](https://ipld.io/docs/codecs/known/dag-pb/) - a binary format for specific limited structures of data, which is highly used in IPFS and [UnixFS](https://specs.ipfs.tech/unixfs/).
4949
- [CAR](https://ipld.io/specs/transport/car/) - transport format used to store content addressable objects in the form of IPLD block data as a sequence of bytes; typically as an [application/vnd.ipld.car](https://www.iana.org/assignments/media-types/application/vnd.ipld.car) file with a `.car` extension
5050
- Self Describing Formats ([multiformats](http://github.com/multiformats/multiformats)):
5151
- [multihash](https://github.com/multiformats/multihash) - self-describing hash digest format.
5252
- [multiaddr](https://github.com/multiformats/multiaddr) - self-describing addressing format.
5353
- [multicodec](https://github.com/multiformats/multicodec) - self-describing protocol/encoding streams (note: a file is a stream).
5454
- [multistream](https://github.com/multiformats/multistream) - multistream is a format -- or simple protocol -- for disambiguating, and layering streams. It is extremely simple.
5555
- **Files and Directories:**
56-
- [UnixFS](./UNIXFS.md)
56+
- [UnixFS](https://specs.ipfs.tech/unixfs/)
5757
- Related userland concepts (external docs):
5858
- [MFS, Mutable File System, or the Files API](https://docs.ipfs.tech/concepts/file-systems/#mutable-file-system-mfs)
5959
- **Storage Layer:**
6060
- [Pinning Service API](https://ipfs.github.io/pinning-services-api-spec/)
61-
- [Repo](./REPO.md) - IPFS node local repository spec
62-
- [FileSystem Repo](./REPO_FS.md) - IPFS node local repository spec
61+
- [Repo](https://github.com/ipfs/kubo/blob/master/docs/specifications/repository.md) - Kubo-specific local repository implementation details
62+
- [FileSystem Repo](https://github.com/ipfs/kubo/blob/master/docs/specifications/repository_fs.md) - Kubo-specific filesystem repository implementation
6363
- **Block Exchanges:**
64-
- [Bitswap](./BITSWAP.md) - BitTorrent-inspired exchange
64+
- [Bitswap](https://specs.ipfs.tech/bitswap-protocol/) - BitTorrent-inspired exchange
6565
- **Key Management:**
66-
- [KeyStore](./KEYSTORE.md) - Key management on IPFS
66+
- [KeyStore](https://github.com/ipfs/kubo/blob/master/docs/specifications/keystore.md) - Kubo-specific key management implementation
6767
- [KeyChain](./KEYCHAIN.md) - Distribution of cryptographic Artifacts
6868
- **Networking layer:**
6969
- [libp2p](https://github.com/libp2p/specs) - libp2p is a modular and extensible network stack, built and use by IPFS, but that it can be reused as a standalone project. Covers:
7070
- **Records, Naming and Record Systems:**
7171
- [IPNS](https://specs.ipfs.tech/ipns/) - InterPlanetary Naming System
72-
- [IPNS Record Creation and Verification](https://specs.ipfs.tech/ipns/ipns-pubsub-router/)
72+
- [IPNS Record Creation and Verification](https://specs.ipfs.tech/ipns/ipns-record/)
7373
- [IPNS over PubSub](https://specs.ipfs.tech/ipns/ipns-pubsub-router/)
7474
- [DNSLink](https://dnslink.dev) - mapping DNS names to IPFS content paths
7575
- [DNSAddr](https://github.com/multiformats/multiaddr/blob/master/protocols/DNSADDR.md) - mapping DNS names to libp2p multiaddrs

0 commit comments

Comments
 (0)