Draft developer docs in /docs/dev/

input-output-hk · May 6, 2024 · 5c21c1c · 5c21c1c
1 parent ae50ec4
commit 5c21c1c
Show file tree

Hide file tree

Showing 17 changed files with 18 additions and 8 deletions.
diff --git a/...oncepts/architecture/architecture-c4.puml → ...ocs/dev/architecture/architecture-c4.puml b/...oncepts/architecture/architecture-c4.puml → ...ocs/dev/architecture/architecture-c4.puml
diff --git a/...oncepts/architecture/hydra-components.svg → ...ocs/dev/architecture/hydra-components.svg b/...oncepts/architecture/hydra-components.svg → ...ocs/dev/architecture/hydra-components.svg
diff --git a/...architecture/hydra-pull-based-network.jpg → ...architecture/hydra-pull-based-network.jpg b/...architecture/hydra-pull-based-network.jpg → ...architecture/hydra-pull-based-network.jpg
diff --git a/docs/core-concepts/architecture/index.md → docs/docs/dev/architecture/index.md b/docs/core-concepts/architecture/index.md → docs/docs/dev/architecture/index.md
diff --git a/.../core-concepts/architecture/networking.md → docs/docs/dev/architecture/networking.md b/.../core-concepts/architecture/networking.md → docs/docs/dev/architecture/networking.md
diff --git a/docs/docs/haskell_packages.md → docs/docs/dev/haskell_packages.md b/docs/docs/haskell_packages.md → docs/docs/dev/haskell_packages.md
diff --git a/docs/docs/hydra-head-lifecycle.svg → docs/docs/dev/hydra-head-lifecycle.svg b/docs/docs/hydra-head-lifecycle.svg → docs/docs/dev/hydra-head-lifecycle.svg
diff --git a/docs/core-concepts/index.md → docs/docs/dev/overview.md b/docs/core-concepts/index.md → docs/docs/dev/overview.md
@@ -20,10 +20,3 @@ A Hydra Head is formed by a group of online and responsive participants. Partici
 While open, they can use the Hydra Head via a hydra-node to submit transactions over the Head network. Transactions have the same format and properties as on the main-chain: they are _isomorphic_. When UTXO entries are spent, and new UTXO entries are created in a Hydra Head, all participants are required to acknowledge and agree on the new state in so-called snapshots (`U1..Un`). Snapshots are _not_ posted back onto the layer 1, but are only kept around by the participants.
 
 Any participant can **close** the Head using a snapshot, when for example they wish to cash out on the mainnet, or if another party misbehaves or stalls the Head's evolution. There is a mechanism to **contest** the final state on the main chain. Ultimately, a **fanout** transaction distributes the final agreed state and makes available on the layer 1 what only existed virtually in the Head.
-
-```mdx-code-block
-import DocCardList from '@theme/DocCardList';
-import {useDocsSidebar} from '@docusaurus/theme-common/internal';
-
-<DocCardList items={useDocsSidebar().items.filter(({ docId }) => docId != "index")}/>
-```
diff --git a/docs/core-concepts/rollbacks/_category_.json → docs/docs/dev/rollbacks/_category_.json b/docs/core-concepts/rollbacks/_category_.json → docs/docs/dev/rollbacks/_category_.json
diff --git a/docs/core-concepts/rollbacks/index.md → docs/docs/dev/rollbacks/index.md b/docs/core-concepts/rollbacks/index.md → docs/docs/dev/rollbacks/index.md
diff --git a/docs/core-concepts/rollbacks/rollbacks-1.jpg → docs/docs/dev/rollbacks/rollbacks-1.jpg b/docs/core-concepts/rollbacks/rollbacks-1.jpg → docs/docs/dev/rollbacks/rollbacks-1.jpg
diff --git a/docs/core-concepts/rollbacks/rollbacks-2.jpg → docs/docs/dev/rollbacks/rollbacks-2.jpg b/docs/core-concepts/rollbacks/rollbacks-2.jpg → docs/docs/dev/rollbacks/rollbacks-2.jpg
diff --git a/docs/core-concepts/rollbacks/rollbacks-3.jpg → docs/docs/dev/rollbacks/rollbacks-3.jpg b/docs/core-concepts/rollbacks/rollbacks-3.jpg → docs/docs/dev/rollbacks/rollbacks-3.jpg
diff --git a/docs/core-concepts/rollbacks/rollbacks-4.jpg → docs/docs/dev/rollbacks/rollbacks-4.jpg b/docs/core-concepts/rollbacks/rollbacks-4.jpg → docs/docs/dev/rollbacks/rollbacks-4.jpg
diff --git a/docs/core-concepts/specification.md → docs/docs/dev/specification.md b/docs/core-concepts/specification.md → docs/docs/dev/specification.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -46,7 +46,7 @@ const config = {
         docs: {
           editUrl,
           editLocalizedFiles: true,
-          sidebarPath: require.resolve("./sidebar.js"),
+          sidebarPath: require.resolve("./sidebars.js"),
           sidebarCollapsible: false,
         },
         blog: {
@@ -165,6 +165,11 @@ const config = {
             label: "User Manual",
             position: "left",
           },
+          {
+            to: "/docs/dev/overview",
+            label: "Developer Documentation",
+            position: "left",
+          },
           {
             href: "https://github.com/input-output-hk/hydra",
             label: "GitHub",

diff --git a/docs/sidebar.js → docs/sidebars.js b/docs/sidebar.js → docs/sidebars.js
@@ -105,4 +105,16 @@ module.exports = {
       label: "Benchmarks",
     },
   ],
+
+  developerDocumentation: [
+    {
+      type: "autogenerated",
+      dirName: "dev",
+    },
+    {
+      type: "link",
+      href: "/adr",
+      label: "Architecture Decision Records",
+    },
+  ],
 };