diff --git a/README.md b/README.md index 9adbfbd..28a7d1e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Makiko is an asynchronous SSH client library in pure Rust. **[Tutorial][tutorial] | [API docs][docs-rs] | [Github][github] | [Crate][crates-io]** -[tutorial]: https://honzasp.github.io/makiko +[tutorial]: https://honzasp.github.io/makiko/tutorial [docs-rs]: https://docs.rs/makiko/latest/makiko [github]: https://github.com/honzasp/makiko [crates-io]: https://crates.io/crates/makiko diff --git a/docs/index.md b/docs/index.md index 5c9714e..3a0c5c7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ layout: home {{ site.description }} {: .fs-6 .fw-300 .text-grey-dk-200} -[Get started](/tutorial){: .btn .btn-primary } +[Get started]({% link tutorial/index.md %}){: .btn .btn-primary } [API docs][docs-rs]{: .btn .ml-4 } [Github][github]{: .btn .ml-4 } [Crate][crates-io]{: .btn .ml-4 } diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md index c3e5c29..3c70af5 100644 --- a/docs/tutorial/index.md +++ b/docs/tutorial/index.md @@ -8,7 +8,7 @@ has_children: true Makiko is an asynchronous SSH client library for Rust. It gives you a lot of control over the SSH connection, but this means that it is quite low-level. -In this tutorial, we will to connect to a server, authenticate with a password or a public key, execute a command and open a tunnel. I will assume that you know [Rust][rust], have some experience with [Tokio][tokio] and have used SSH previously. +In this tutorial, we will connect to a server, authenticate with a password or a public key, execute a command and open a tunnel. I will assume that you know [Rust][rust], have some experience with [Tokio][tokio] and have used SSH previously. [rust]: https://www.rust-lang.org/ [tokio]: https://tokio.rs/ diff --git a/src/lib.rs b/src/lib.rs index c5101e7..eeee3e4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,7 +2,7 @@ //! //! You may want to **[read the tutorial][tutorial]** to get started with Makiko. //! -//! [tutorial]: https://honzasp.github.io/makiko +//! [tutorial]: https://honzasp.github.io/makiko/tutorial //! //! - Entry point for making SSH connections is the [`Client`]. //! - Functions for decoding keys are in the [`keys`] module.