Skip to content

Commit

Permalink
Fix some links and do best-effort redirects
Browse files Browse the repository at this point in the history
The client side redirects will not work for deep links though.
  • Loading branch information
ch1bo committed May 8, 2024
1 parent 25c6d7b commit ab9be42
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/adr/2022-03-28_017-udp-networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Current Hydra networking layer is based on [Ouroboros network framework](https:/
2. A Multiplexing connection manager that manages a set of equivalent peers, maintains connectivity, and ensures diffusion of messages to/from all peers,
2. Typed protocols for expressing the logic of message exchanges as a form of _state machine_.

While it's been working mostly fine so far, the abstractions and facilities provided by this network layer are not well suited for Hydra Head networking. Some of the questions and shortcomings are discussed in a document on [Networking Requirements](/core-concepts/architecture/networking), and as the Hydra Head matures it seems time is ripe for overhauling current network implementation to better suite current and future Hydra Head networks needs.
While it's been working mostly fine so far, the abstractions and facilities provided by this network layer are not well suited for Hydra Head networking. Some of the questions and shortcomings are discussed in a document on [Networking Requirements](/docs/dev/architecture/networking), and as the Hydra Head matures it seems time is ripe for overhauling current network implementation to better suite current and future Hydra Head networks needs.

## Decision

Expand Down
6 changes: 1 addition & 5 deletions docs/docs/tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,11 +380,7 @@ With all these parameters defined, we now pick a HYDRA_VERSION of the Head proto
want to use. This is defined by the `hydra-node --HYDRA_VERSION` itself and the
`--hydra-scripts-tx-id` which point to scripts published on-chain.

For all [released](https://github.com/input-output-hk/hydra/releases) HYDRA_VERSIONs
of the `hydra-node` and common Cardano networks, the scripts do get
pre-published and we can just use them. See the [user
manual](../getting-started/quickstart#reference-scripts) for more information
how to publish scripts yourself.
For all [released](https://github.com/input-output-hk/hydra/releases) HYDRA_VERSIONs of the `hydra-node` and common Cardano networks, the scripts do get pre-published and we can just use them. See the [user manual](../configuration#reference-scripts) for more information how to publish scripts yourself.

Let's start the `hydra-node` with all these parameters now:

Expand Down
5 changes: 5 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ const config = {
"@docusaurus/plugin-client-redirects",
{
redirects: [
// Docs restructuring (2024-05-08)
{
from: "/core-concepts/specification",
to: "/docs/dev/specification",
},
// Use cases section re-organized (2023-07-25)
{
from: "/use-cases/poker-game",
Expand Down
4 changes: 2 additions & 2 deletions docs/standalone/audit-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This sections gives a detailed description of the artifacts mentioned above in t

The Hydra Head protocol implementation derives from [Hydra: Fast Isomorphic State Channels](https://eprint.iacr.org/2020/299.pdf) in several ways. Especially some simplifications have been introduced and generalizations removed.

The [Hydra Head specification](/core-concepts/specification) captures these deviations and also includes the "formal notation" of the actual transaction constraints (which are foregone in the original paper). Also, it details the L2 protocol logic for the **Coordinated** Head protocol - which is implemented in V1.
The [Hydra Head specification](/docs/dev/specification) captures these deviations and also includes the "formal notation" of the actual transaction constraints (which are foregone in the original paper). Also, it details the L2 protocol logic for the **Coordinated** Head protocol - which is implemented in V1.

### Artifact 2: Hydra Head Protocol Implementation

Expand All @@ -140,4 +140,4 @@ Hydra plutus mutation based testing can be found in the [hydra-node module](http

Hydra node chain layer code can be found in the [hydra-node module](https://github.com/input-output-hk/hydra/tree/master/hydra-node/src/Hydra/Chain) in src/Hydra/Chain/Direct/

Hydra node chain layer tests can be found in the [hydra-node module](https://github.com/input-output-hk/hydra/tree/master/hydra-node/test/Hydra/Chain) in test/Hydra/Chain/Direct/
Hydra node chain layer tests can be found in the [hydra-node module](https://github.com/input-output-hk/hydra/tree/master/hydra-node/test/Hydra/Chain) in test/Hydra/Chain/Direct/
2 changes: 1 addition & 1 deletion hydra-node/src/Hydra/Node.hs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
-- | Top-level module to run a single Hydra node.
--
-- Checkout [Hydra
-- Documentation](https://hydra.family/head-protocol/core-concepts/architecture)
-- Documentation](https://hydra.family/head-protocol/dev/architecture)
-- for some details about the overall architecture of the `Node`.
module Hydra.Node where

Expand Down

0 comments on commit ab9be42

Please sign in to comment.