Merge branch 'main' into feat/ipip-remove-ipld-translation

Author: lidel

ARCHITECTURE.md

@@ -1,4 +1,4 @@
-# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) IPFS Architecture Overview
+# ![status: deprecated](https://img.shields.io/badge/status-deprecated-red.svg?style=flat-square) IPFS Architecture Overview
 
 > [!NOTE]
 > This document contains historical notes about IPFS architecture from ~2015. For current specifications, please refer to https://specs.ipfs.tech/
@@ -12,20 +12,20 @@
 
 * * *
 
-**Abstract**
+## Abstract
 
 This spec document defines the IPFS protocol stack, the subsystems, the interfaces, and how it all fits together. It delegates non-interface details to other specs as much as possible. This is meant as a top-level view of the protocol and how the system fits together.
 
 Note, this document is not meant to be an introduction of the concepts in IPFS and is not recommended as a first pass to understanding how IPFS works. For that, please refer to the [IPFS paper](https://github.com/ipfs/papers/raw/master/ipfs-cap2pfs/ipfs-p2p-file-system.pdf).
 
 # Table of Contents
 
-- 1. IPFS and the Merkle DAG
-- 2. Nodes and Network Model
-- 3. The Stack
-- 4. Applications and data structures -- on top of IPFS
-- 5. Lifetime of fetching an object
-- 6. IPFS User Interfaces
+1. IPFS and the Merkle DAG
+1. Nodes and Network Model
+1. The Stack
+1. Applications and data structures -- on top of IPFS
+1. Lifetime of fetching an object
+1. IPFS User Interfaces
 
 # 1. IPFS and the Merkle DAG
 
@@ -48,7 +48,6 @@ In turn, these yield properties for the system as a whole:
 
 IPFS is a stack of network protocols that organize agent networks to create, publish, distribute, serve, and download merkledags. It is the authenticated, decentralized, permanent web.
 
-
 # 2. Nodes and Network Model
 
 The IPFS network uses PKI based identity. An "ipfs node" is a program that can find, publish, and replicate merkledag objects. Its identity is defined by a private key. Specifically:
@@ -72,7 +71,6 @@ sha2-512
 sha3
 ```
 
-
 # 3. The Stack
 
 IPFS has a stack of modular protocols. Each layer may have multiple implementations, all in different modules. This spec will only address the interfaces between the layers, and briefly mention possible implementations. Details are left to the other specs.
@@ -85,7 +83,7 @@ IPFS has five layers:
 - **routing** - locating peers and objects
 - **network** - establishing connections between peers
 
-![](img/ipfs-stack.png)
+![IPFS protocol stack](img/ipfs-stack.png)
 
 These are briefly described bottom-up.
 
@@ -165,7 +163,7 @@ The merkledag is enough to resolve paths:
 
 See more in the [path resolution spec](https://github.com/ipld/specs/blob/master/data-model-layer/paths.md).
 
-![](img/ipfs-resolve/ipfs-resolve.gif)
+![IPFS path resolution](img/ipfs-resolve/ipfs-resolve.gif)
 
 ## 3.5 Naming -- PKI namespace and mutable pointers
 
@@ -196,7 +194,7 @@ The unix filesystem abstractions -- files and directories -- are the main way pe
 
 See more in the [unixfs spec](https://github.com/ipfs/specs/blob/master/UNIXFS.md).
 
-## 5. Lifetime of fetching an object.
+## 5. Lifetime of fetching an object
 
 Suppose we ask an IPFS node to retrieve
 
@@ -225,7 +223,7 @@ IPFS is not just a protocol. It is also a toolset. IPFS implementations include
 
 * * *
 
-# WIP Stack Dump:
+# WIP Stack Dump
 
 - How the layers fit together
 - How they call on each other

src/http-gateways/dnslink-gateway.md

@@ -69,7 +69,9 @@ Implementations MUST ensure DNSLink resolution is safe and correct:
   recursion limit (e.g. 32) and HTTP 400 Bad Request error MUST be returned
   when the limit is reached.
 
-**Example: resolving an advanced DNSLink chain**
+:::note
+
+Example: resolving an advanced DNSLink chain
 
 To illustrate, given DNSLink records:
 
@@ -85,6 +87,8 @@ content path:
 3. Resolving DNSlink at `b.example.net` replaces `/ipns/b.example.net` with `/ipfs/bafy…qy3k/path-c`
 4. The immutable content path is `/ipfs/bafy…qy3k/path-c/path-b/path-a`
 
+:::
+
 # HTTP Response
 
 Same as "HTTP Response" of :cite[path-gateway].