From b8d32388bc99fd6d537313bdcf2629c20cc87c54 Mon Sep 17 00:00:00 2001
From: John Ericson <John.Ericson@Obsidian.Systems>
Date: Mon, 24 Nov 2025 15:20:19 -0500
Subject: [PATCH] Move derivation JSON doc to `index.md` in dir

This prepares for more structure.
---
 doc/manual/source/SUMMARY.md.in                           | 2 +-
 .../protocols/json/{derivation.md => derivation/index.md} | 2 +-
 .../protocols/json/fixup-json-schema-generated-doc.sed    | 8 ++++----
 doc/manual/source/release-notes/rl-2.32.md                | 2 +-
 doc/manual/source/store/derivation/index.md               | 2 +-
 src/nix/derivation-add.md                                 | 2 +-
 src/nix/derivation-show.md                                | 2 +-
 7 files changed, 10 insertions(+), 10 deletions(-)
 rename doc/manual/source/protocols/json/{derivation.md => derivation/index.md} (75%)

diff --git a/doc/manual/source/SUMMARY.md.in b/doc/manual/source/SUMMARY.md.in
index 806489bb3..0d32e3628 100644
--- a/doc/manual/source/SUMMARY.md.in
+++ b/doc/manual/source/SUMMARY.md.in
@@ -126,7 +126,7 @@
     - [Content Address](protocols/json/content-address.md)
     - [Store Path](protocols/json/store-path.md)
     - [Store Object Info](protocols/json/store-object-info.md)
-    - [Derivation](protocols/json/derivation.md)
+    - [Derivation](protocols/json/derivation/index.md)
     - [Deriving Path](protocols/json/deriving-path.md)
     - [Build Trace Entry](protocols/json/build-trace-entry.md)
     - [Build Result](protocols/json/build-result.md)
diff --git a/doc/manual/source/protocols/json/derivation.md b/doc/manual/source/protocols/json/derivation/index.md
similarity index 75%
rename from doc/manual/source/protocols/json/derivation.md
rename to doc/manual/source/protocols/json/derivation/index.md
index 13092773f..0b15acb8f 100644
--- a/doc/manual/source/protocols/json/derivation.md
+++ b/doc/manual/source/protocols/json/derivation/index.md
@@ -1,4 +1,4 @@
-{{#include derivation-v4-fixed.md}}
+{{#include ../derivation-v4-fixed.md}}
 
 <!-- need to convert YAML to JSON first
 ## Raw Schema
diff --git a/doc/manual/source/protocols/json/fixup-json-schema-generated-doc.sed b/doc/manual/source/protocols/json/fixup-json-schema-generated-doc.sed
index 9f7b750da..96b6f1801 100644
--- a/doc/manual/source/protocols/json/fixup-json-schema-generated-doc.sed
+++ b/doc/manual/source/protocols/json/fixup-json-schema-generated-doc.sed
@@ -12,7 +12,7 @@ s/\\`/`/g
 # As we have more such relative links, more replacements of this nature
 # should appear below.
 s^#/\$defs/\(regular\|symlink\|directory\)^In this schema^g
-s^\(./hash-v1.yaml\)\?#/$defs/algorithm^[JSON format for `Hash`](./hash.html#algorithm)^g
-s^\(./hash-v1.yaml\)^[JSON format for `Hash`](./hash.html)^g
-s^\(./content-address-v1.yaml\)\?#/$defs/method^[JSON format for `ContentAddress`](./content-address.html#method)^g
-s^\(./content-address-v1.yaml\)^[JSON format for `ContentAddress`](./content-address.html)^g
+s^\(./hash-v1.yaml\)\?#/$defs/algorithm^[JSON format for `Hash`](@docroot@/protocols/json/hash.html#algorithm)^g
+s^\(./hash-v1.yaml\)^[JSON format for `Hash`](@docroot@/protocols/json/hash.html)^g
+s^\(./content-address-v1.yaml\)\?#/$defs/method^[JSON format for `ContentAddress`](@docroot@/protocols/json/content-address.html#method)^g
+s^\(./content-address-v1.yaml\)^[JSON format for `ContentAddress`](@docroot@/protocols/json/content-address.html)^g
diff --git a/doc/manual/source/release-notes/rl-2.32.md b/doc/manual/source/release-notes/rl-2.32.md
index 3a925198d..5d90da0c9 100644
--- a/doc/manual/source/release-notes/rl-2.32.md
+++ b/doc/manual/source/release-notes/rl-2.32.md
@@ -12,7 +12,7 @@
 
   We ultimately want to rectify this issue with all JSON formats to the extent allowed by our stability promises. To start with, we are changing the JSON format for derivations because the `nix derivation` commands are — in addition to being formally unstable — less widely used than other unstable commands.
 
-  See the documentation on the [JSON format for derivations](@docroot@/protocols/json/derivation.md) for further details.
+  See the documentation on the [JSON format for derivations](@docroot@/protocols/json/derivation/index.md) for further details.
 
 - C API: `nix_get_attr_name_byidx`, `nix_get_attr_byidx` take a `nix_value *` instead of `const nix_value *` [#13987](https://github.com/NixOS/nix/pull/13987)
 
diff --git a/doc/manual/source/store/derivation/index.md b/doc/manual/source/store/derivation/index.md
index 670f3b2bd..3a14d06bc 100644
--- a/doc/manual/source/store/derivation/index.md
+++ b/doc/manual/source/store/derivation/index.md
@@ -192,7 +192,7 @@ There are two formats, documented separately:
 
 - The legacy ["ATerm" format](@docroot@/protocols/derivation-aterm.md)
 
-- The experimental, currently under development and changing [JSON format](@docroot@/protocols/json/derivation.md)
+- The experimental, currently under development and changing [JSON format](@docroot@/protocols/json/derivation/index.md)
 
 Every derivation has a canonical choice of encoding used to serialize it to a store object.
 This ensures that there is a canonical [store path] used to refer to the derivation, as described in [Referencing derivations](#derivation-path).
diff --git a/src/nix/derivation-add.md b/src/nix/derivation-add.md
index 4e37c4e6f..69a821d4e 100644
--- a/src/nix/derivation-add.md
+++ b/src/nix/derivation-add.md
@@ -13,6 +13,6 @@ a Nix expression evaluates.
 [store derivation]: @docroot@/glossary.md#gloss-store-derivation
 
 `nix derivation add` takes a single derivation in the JSON format.
-See [the manual](@docroot@/protocols/json/derivation.md) for a documentation of this format.
+See [the manual](@docroot@/protocols/json/derivation/index.md) for a documentation of this format.
 
 )""
diff --git a/src/nix/derivation-show.md b/src/nix/derivation-show.md
index 1784be44c..6948b5ba7 100644
--- a/src/nix/derivation-show.md
+++ b/src/nix/derivation-show.md
@@ -49,7 +49,7 @@ By default, this command only shows top-level derivations, but with
 [store derivation]: @docroot@/glossary.md#gloss-store-derivation
 
 `nix derivation show` outputs a JSON map of [store path]s to derivations in JSON format.
-See [the manual](@docroot@/protocols/json/derivation.md) for a documentation of this format.
+See [the manual](@docroot@/protocols/json/derivation/index.md) for a documentation of this format.
 
 [store path]: @docroot@/store/store-path.md