Enable errors on broken links and fix haddock paths

cardano-scaling · Dec 25, 2024 · c29a27a · c29a27a
1 parent b46fad2
commit c29a27a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/benchmarks/profiling.md b/docs/benchmarks/profiling.md
@@ -39,7 +39,7 @@ Here, isolate the transaction for `5` parties by altering the function to `maybe
 
 ## Compiling a script for profiling
 
-The `collectCom` transaction utilizes the `vCommit` and `vHead` validator scripts. To enable profiling, add the following directive to the modules [`Hydra.Contract.Commit`](/haddock/hydra-plutus/Hydra-Contract-Commit.html) and [`Hydra.Contract.Head`](/haddock/hydra-plutus/Hydra-Contract-Head.html):
+The `collectCom` transaction utilizes the `vCommit` and `vHead` validator scripts. To enable profiling, add the following directive to the modules [`Hydra.Contract.Commit`](pathname:///haddock/hydra-plutus/Hydra-Contract-Commit.html) and [`Hydra.Contract.Head`](pathname:///haddock/hydra-plutus/Hydra-Contract-Head.html):
 
 ```
 {-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:profile-all #-}
@@ -48,7 +48,7 @@ The `collectCom` transaction utilizes the `vCommit` and `vHead` validator script
 ## Acquiring an executable script
 
 You can achieve this using
-[`prepareTxScripts`](/haddock/hydra-tx/Hydra-Ledger-Cardano-Evaluate.html#v:prepareTxScripts).
+[`prepareTxScripts`](pathname:///haddock/hydra-tx/Hydra-Ledger-Cardano-Evaluate.html#v:prepareTxScripts).
 To acquire and save the fully applied scripts from the transaction onto disk, run:
 
 ```haskell

diff --git a/docs/docs/dev/architecture/networking.md b/docs/docs/dev/architecture/networking.md
@@ -74,7 +74,7 @@ See also [this ADR](/adr/27) for a past discussion on making the network compone
 
 ### Current network stack
 
-See [haddocks](/haddock/hydra-node/Hydra-Node-Network.html)
+See [haddocks](pathname:///haddock/hydra-node/Hydra-Node-Network.html)
 
 - Hydra nodes form a network of pairwise connected *peers* using point-to-point (eg, TCP) connections that are expected to remain active at all times:
   - Nodes use [Ouroboros](https://github.com/input-output-hk/ouroboros-network/) as the underlying network abstraction, which manages connections with peers via a reliable point-to-point stream-based communication framework known as a `Snocket`

diff --git a/docs/docs/dev/commit_to_a_Head.md b/docs/docs/dev/commit_to_a_Head.md
@@ -84,7 +84,7 @@ users can request a recover by providing a `TxId` of the deposit transaction
 which initially locked the funds.
 
 ::::info
-Users can also request to see pending deposits. See our api [documentation](/api-reference/#operation-publish-/commits).
+Users can also request to see pending deposits. See our api [documentation](/api-reference).
 ::::
 
 Any Head participant can request to recover the deposit not only the one which initially deposited the funds.

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -19,7 +19,7 @@ const config = {
   baseUrl: "/head-protocol/",
   // Note: This gives warnings about the haddocks; but actually they are
   // present. If you are concerned, please check the links manually!
-  onBrokenLinks: "warn",
+  onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "warn",
   favicon: "img/hydra.png",
   organizationName: "Input Output",