Skip to content

Commit

Permalink
[Docs] Rename / add a welcome page
Browse files Browse the repository at this point in the history
  • Loading branch information
ch1bo committed May 6, 2024
1 parent 1292efc commit 97b2532
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
11 changes: 11 additions & 0 deletions docs/docs/dev/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 1
---

# About Hydra

So you read already the [User Manual](../index.md) and still want to learn more about the Hydra protocol, its inner workings and how it is implemented?

Look no further...

<!-- TODO: complete intro -->
21 changes: 7 additions & 14 deletions docs/docs/getting-started/index.md → docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
sidebar_position: 1
---
# Welcome

# Getting Started

Hydra is the layer-two scalability solution for Cardano, which aims to increase
Hydra is a layer-two scalability solution for Cardano, which aims to increase
the speed of transactions (low latency, high throughput) and minimize
transaction cost.

This repository contains the implementation for the Hydra [Head
protocol](https://eprint.iacr.org/2020/299.pdf). Most prominently, it contains a
`hydra-node`, which runs a simplified (coordinated) Hydra Head protocol,
connects to other `hydra-node`s, interfaces the Cardano blockchain and provides an
API to clients such as the included example terminal user interface `hydra-tui`.
This is the user manual for `hydra-node`, an implementation of the Hydra Head protocol, as originally published [here](https://eprint.iacr.org/2020/299.pdf). The `hydra-node` interfaces the Cardano blockchain, connects to other `hydra-node`s on a dedicated overlay network, runs a simplified (coordinated) Hydra Head protocol, and provides an API to clients.

:::warning Mainnet Availability
:::warning Mainnet Availability disclaimer

The Hydra Head protocol version 0.10.0 or newer is compatible with the Cardano
mainnet, which means it is possible to run a `hydra-node` on mainnet using real
Expand All @@ -36,8 +28,9 @@ on hydra.family and Hydra Github Repository is available on an ‘AS IS’ and
AVAILABLE’ basis, without any representations or warranties of any kind. All
implied terms are excluded to the fullest extent permitted by law. For details,
see also sections 7, 8 and 9 of the [Apache 2.0 License][license].

:::

[known-issues]: ../known-issues
Now, without further ado, read more about the protocol [on the next page](./protocol-overview.md) or jump right in to [getting started using a local devnet](./tutorial-devnet.md).

[known-issues]: ./known-issues.md
[license]: https://github.com/input-output-hk/hydra/blob/master/LICENSE
4 changes: 2 additions & 2 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -156,12 +156,12 @@ const config = {
},
items: [
{
to: "/docs/getting-started",
to: "/docs",
label: "User Manual",
position: "left",
},
{
to: "/docs/dev/overview",
to: "/docs/dev",
label: "Developer Documentation",
position: "left",
},
Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module.exports = {
{
type: "doc",
label: "Welcome",
id: "getting-started/index",
id: "index",
},
{
type: "doc",
Expand Down

0 comments on commit 97b2532

Please sign in to comment.