From e486b76eef135cdb1f112b9bb2ffcbf6a08f7c96 Mon Sep 17 00:00:00 2001
From: Valentin Gagarin <valentin.gagarin@tweag.io>
Date: Thu, 8 Feb 2024 09:08:58 +0100
Subject: [PATCH] move JSON section into Formats and Protocols

---
 doc/manual/src/SUMMARY.md.in                             | 8 ++++----
 doc/manual/src/_redirects                                | 1 +
 doc/manual/src/{ => protocols}/json/derivation.md        | 0
 doc/manual/src/{ => protocols}/json/store-object-info.md | 5 +++--
 src/nix/derivation-add.md                                | 2 +-
 src/nix/derivation-show.md                               | 2 +-
 6 files changed, 10 insertions(+), 8 deletions(-)
 rename doc/manual/src/{ => protocols}/json/derivation.md (100%)
 rename doc/manual/src/{ => protocols}/json/store-object-info.md (96%)

diff --git a/doc/manual/src/SUMMARY.md.in b/doc/manual/src/SUMMARY.md.in
index 695d63dfc..167f54206 100644
--- a/doc/manual/src/SUMMARY.md.in
+++ b/doc/manual/src/SUMMARY.md.in
@@ -104,10 +104,10 @@
     - [Channels](command-ref/files/channels.md)
     - [Default Nix expression](command-ref/files/default-nix-expression.md)
 - [Architecture and Design](architecture/architecture.md)
-- [JSON Formats](json/index.md)
-  - [Store Object Info](json/store-object-info.md)
-  - [Derivation](json/derivation.md)
-- [Protocols](protocols/index.md)
+- [Formats and Protocols](protocols/index.md)
+  - [JSON Formats](protocols/json/index.md)
+    - [Store Object Info](protocols/json/store-object-info.md)
+    - [Derivation](protocols/json/derivation.md)
   - [Serving Tarball Flakes](protocols/tarball-fetcher.md)
   - [Derivation "ATerm" file format](protocols/derivation-aterm.md)
 - [Glossary](glossary.md)
diff --git a/doc/manual/src/_redirects b/doc/manual/src/_redirects
index 62c693c97..8bf0e854b 100644
--- a/doc/manual/src/_redirects
+++ b/doc/manual/src/_redirects
@@ -36,5 +36,6 @@
 /package-management/s3-substituter /store/types/s3-binary-cache-store 301!
 
 /protocols/protocols /protocols 301!
+/json/* /protocols/json/:splat 301!
 
 /release-notes/release-notes /release-notes 301!
diff --git a/doc/manual/src/json/derivation.md b/doc/manual/src/protocols/json/derivation.md
similarity index 100%
rename from doc/manual/src/json/derivation.md
rename to doc/manual/src/protocols/json/derivation.md
diff --git a/doc/manual/src/json/store-object-info.md b/doc/manual/src/protocols/json/store-object-info.md
similarity index 96%
rename from doc/manual/src/json/store-object-info.md
rename to doc/manual/src/protocols/json/store-object-info.md
index db43c2fa1..ba4ab098f 100644
--- a/doc/manual/src/json/store-object-info.md
+++ b/doc/manual/src/protocols/json/store-object-info.md
@@ -14,11 +14,11 @@ Info about a [store object].
 
 * `narHash`:
 
-  Hash of the [file system object] part of the store object when serialized as a [Nix Archive](#gloss-nar).
+  Hash of the [file system object] part of the store object when serialized as a [Nix Archive].
 
 * `narSize`:
 
-  Size of the [file system object] part of the store object when serialized as a [Nix Archive](#gloss-nar).
+  Size of the [file system object] part of the store object when serialized as a [Nix Archive].
 
 * `references`:
 
@@ -30,6 +30,7 @@ Info about a [store object].
 
 [store path]: @docroot@/glossary.md#gloss-store-path
 [file system object]: @docroot@/store/file-system-object.md
+[Nix Archive]: @docroot@/glossary.md#gloss-nar
 
 ## Impure fields
 
diff --git a/src/nix/derivation-add.md b/src/nix/derivation-add.md
index d9b8467df..331cbdd88 100644
--- a/src/nix/derivation-add.md
+++ b/src/nix/derivation-add.md
@@ -14,6 +14,6 @@ a Nix expression evaluates.
 
 `nix derivation add` takes a single derivation in the following format:
 
-{{#include ../../json/derivation.md}}
+{{#include ../../protocols/json/derivation.md}}
 
 )""
diff --git a/src/nix/derivation-show.md b/src/nix/derivation-show.md
index 884f1adc6..2437ea08f 100644
--- a/src/nix/derivation-show.md
+++ b/src/nix/derivation-show.md
@@ -52,6 +52,6 @@ By default, this command only shows top-level derivations, but with
 
 [store path]: @docroot@/glossary.md#gloss-store-path
 
-{{#include ../../json/derivation.md}}
+{{#include ../../protocols/json/derivation.md}}
 
 )""