Skip to content

Commit

Permalink
[Docs] Rename / add a welcome page
Browse files Browse the repository at this point in the history
This should become more welcoming though..
  • Loading branch information
ch1bo committed May 6, 2024
1 parent 1292efc commit 321f2dc
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 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 -->
10 changes: 3 additions & 7 deletions docs/docs/getting-started/index.md → docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
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.

Expand Down Expand Up @@ -39,5 +35,5 @@ see also sections 7, 8 and 9 of the [Apache 2.0 License][license].

:::

[known-issues]: ../known-issues
[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 321f2dc

Please sign in to comment.