Skip to content

Commit d271323

Browse files
authored
filip(fix): add config for trailing slashes (#1764)
<!-- Describe your change here --> add config for trailing slashes on docs site --- <!-- Consider each and tick it off one way or the other --> * [ ] CHANGELOG updated or not needed * [X] Documentation updated * [ ] Haddocks updated or not needed * [ ] No new TODOs introduced or explained herafter
2 parents 9bb093a + 3f7dc68 commit d271323

File tree

7 files changed

+9
-8
lines changed

7 files changed

+9
-8
lines changed

docs/docs/dev/architecture/hydra-components.svg

+1-1
Loading

docs/docs/dev/architecture/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ $ plantuml -Tsvg architecture-c4.puml
2323

2424
### Network
2525

26-
The _network_ component is responsible for communication between Hydra nodes related to the off-chain part of the Hydra protocol. See [Networking](./networking) for details.
26+
The _network_ component is responsible for communication between Hydra nodes related to the off-chain part of the Hydra protocol. See [Networking](./architecture/networking) for details.
2727

2828
### Chain interaction
2929

docs/docs/dev/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ If you've read the [user manual](../index.md) and want to learn more about the H
44

55
The developer documentation provides detailed materials that move beyond just _using_ Hydra to _understanding_ it. This section is for anyone looking to gain a comprehensive understanding of the Hydra protocol, including protocol architects interested in developing their own variants and developers contributing to the [reference implementation](https://github.com/input-output-hk/hydra) of Hydra.
66

7-
The following sections are more technical and may be less cohesive than the user manual. However, the [architecture](./architecture) and the [specification](./specification) sections are good starting points.
7+
The following sections are more technical and may be less cohesive than the user manual. However, the [architecture](./dev/architecture) and the [specification](./dev/specification) sections are good starting points.

docs/docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section is a manual for users interested in running a Hydra node.
44

55
Hydra node is an implementation of the Hydra Head protocol, designed to enable fast and low-cost transactions by operating off-chain while leveraging the security of the main Cardano blockchain.
66

7-
Decentralized applications (DApps), exchanges, and enterprise-level services can choose to run a Hydra node to participate in forming Hydra heads – mini-ledgers that process transactions independently and in parallel, significantly enhancing throughput and reducing latency.
7+
Decentralized applications (DApps), exchanges, and enterprise-level services can choose to run a Hydra node to participate in forming Hydra heads – mini-ledgers that process transactions independently and in parallel, significantly enhancing throughput and reducing latency.
88

99
The `hydra-node` interfaces with the Cardano blockchain, connects to other `hydra-nodes` on a dedicated overlay network, runs a simplified (coordinated) Hydra Head protocol, and provides an API for clients.
1010

@@ -32,7 +32,7 @@ implied terms are excluded to the fullest extent permitted by law. For details,
3232
see also sections 7, 8 and 9 of the [Apache 2.0 License][license].
3333
:::
3434

35-
Now, without further ado, you can learn more about the protocol by visiting the [protocol overview page](./protocol-overview) or directly dive into [getting started using a local devnet](./getting-started).
35+
Now, without further ado, you can learn more about the protocol by visiting the [protocol overview page](./docs/protocol-overview) or directly dive into [getting started using a local devnet](./docs/getting-started).
3636

3737
[known-issues]: ./known-issues.md
3838
[license]: https://github.com/cardano-scaling/hydra/blob/master/LICENSE

docs/docs/tutorial/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ In summary, the Hydra head participants exchanged and agreed on:
386386
## Step 3. Start the Hydra node
387387

388388

389-
Scripts are pre-published for all [released](https://github.com/cardano-scaling/hydra/releases) HYDRA_VERSIONs of the `hydra-node` and common Cardano networks. Consult the [user manual](../configuration#reference-scripts) for guidance on publishing your own scripts.
389+
Scripts are pre-published for all [released](https://github.com/cardano-scaling/hydra/releases) HYDRA_VERSIONs of the `hydra-node` and common Cardano networks. Consult the [user manual](../docs/configuration#reference-scripts) for guidance on publishing your own scripts.
390390

391391

392392
Start the `hydra-node` using these parameters:

docs/docusaurus.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ const config = {
2424
projectName: "Hydra",
2525
staticDirectories: ["static", customFields.apiSpecDir],
2626
customFields,
27+
trailingSlash: false,
2728

2829
scripts: [
2930
{

docs/topologies/managed/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This document outlines the _managed Hydra head_ topology, which could also be de
2121
/>
2222
</p>
2323

24-
The [basic Hydra head setup](../basic) requires each participant to host an instance of a `hydra-node`, similar to how `cardano-node`s operate on the Cardano network. In contrast, 'light node' setups allow users to access the blockchain through a hosted API, with light wallets being a common example.
24+
The [basic Hydra head setup](./basic) requires each participant to host an instance of a `hydra-node`, similar to how `cardano-node`s operate on the Cardano network. In contrast, 'light node' setups allow users to access the blockchain through a hosted API, with light wallets being a common example.
2525

2626
In this topology, clients do not need to run their own `hydra-node`s but instead access a `hydra-node` provided by a _service provider_. Client applications, such as light wallets, do not need to be aware of individual `hydra-node` instances. Instead, logical _Hydra heads_ are accessible via an API.
2727

@@ -30,6 +30,6 @@ For this setup to be feasible, it is crucial that the _Hydra keys_ remain on the
3030

3131
As a result, the client must be online for any progress to occur within a Hydra head. This requirement can be cumbersome in multi-party Hydra heads, as they may stall if a lightweight mobile client is offline for a period. However, this setup aligns well with _two-party Hydra heads_, where a transaction is only completed if both parties are online to send, receive, and acknowledge it.
3232

33-
An example use case for two-party Hydra heads includes payment channels between two [machines](../../use-cases/payments/pay-per-use-api) or [individuals](../../use-cases/payments/inter-wallet-payments), especially if such multiple channels are logically interconnected, similar to the Lightning Network.
33+
An example use case for two-party Hydra heads includes payment channels between two [machines](./../use-cases/payments/pay-per-use-api) or [individuals](./../use-cases/payments/inter-wallet-payments), especially if such multiple channels are logically interconnected, similar to the Lightning Network.
3434

3535
Although access to Hydra heads is facilitated by the service provider, this does not centralize the system. A client can always close a head and recover funds with an alternative provider or even use a transaction created out-of-band (eg, by the client application using another service to submit the transaction).

0 commit comments

Comments
 (0)