Skip to content

Commit

Permalink
Add intro to developer documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ch1bo committed May 8, 2024
1 parent d9d0f62 commit 4f77271
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ 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?
So you already read 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...
The developer documentation can help you with that. It is a collection of materials expanding on _using_ into _understanding_ Hydra. It is aimed anyone wanting to get a deeper understanding of the Hydra protocol, protocol architects who want to build their own variants and of course developers who contribute to the [reference implementation](https://github.com/input-output-hk/hydra) of Hydra itself.

<!-- TODO: complete intro -->
Consequently, the following sections are more technical and maybe not as cohesive as the user manual, but the [architecture](./architecture) or the [specification](./specification) should be a good starting point.
2 changes: 1 addition & 1 deletion docs/docs/dev/specification.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 2
custom_edit_url: https://github.com/input-output-hk/hydra/tree/master/spec
---

Expand Down

0 comments on commit 4f77271

Please sign in to comment.