Skip to content

Commit

Permalink
book: update main paths
Browse files Browse the repository at this point in the history
  • Loading branch information
yukibtc committed Dec 15, 2023
1 parent 834c424 commit cb56738
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions book/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: Rust Nostr Book
site_url: https://rust-nostr.github.io/book
site_url: https://rust-nostr.github.io/nostr
repo_url: https://github.com/rust-nostr/nostr

docs_dir: src
Expand Down Expand Up @@ -71,9 +71,9 @@ nav:
- Home:
- index.md
- Nostr:
- Overview: nostr/01-index.md
- Installation: nostr/02-installation.md
- Keys: nostr/03-keys.md
- Overview: protocol/01-index.md
- Installation: protocol/02-installation.md
- Keys: protocol/03-keys.md
- Nostr SDK:
- Overview: nostr-sdk/01-index.md
- Installation: nostr-sdk/02-installation.md
- Overview: sdk/01-index.md
- Installation: sdk/02-installation.md
6 changes: 3 additions & 3 deletions book/src/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Introduction

Collection of libraries to build fast and secure `nostr` application on `desktop`, `mobile` and `web` environments.
Build **fast**, **stable** and **efficient** nostr apps for **any environment**: desktop/server, mobile, embedded devices and web.

## Libraries

* [Nostr](./nostr/01-index.md): Implementation of the `nostr` protocol
* [Nostr SDK](./nostr-sdk/01-index.md): High level nostr client library
* [Nostr](./protocol/01-index.md): Implementation of the `nostr` protocol
* [Nostr SDK](./sdk/01-index.md): High level nostr client library

## State

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This section include documentation for the `nostr` library for all the supported languages (Rust, Python, Swift and Kotlin).

If you're writing a typical Nostr client or bot, you may be interested in [nostr-sdk](../nostr-sdk/01-index.md).
If you're writing a typical Nostr client or bot, you may be interested in [nostr-sdk](../sdk/01-index.md).
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions book/src/nostr-sdk/01-index.md → book/src/sdk/01-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This section include documentation for the `nostr-sdk` library for all the supported languages (Rust, Python, Swift and Kotlin).

This library depends on `nostr` library so, before continue, take a look to the [`nostr`](../nostr/01-index.md) docs.
This library depends on `nostr` library so, before continue, take a look to the [`nostr`](../protocol/01-index.md) docs.

If you're writing a typical Nostr client or bot, this is likely the library you need.

However, the library is designed in a modular way and depends on several
other lower-level crates. If you're attempting something more custom, you might be interested in [`nostr`](../nostr/01-index.md) library.
other lower-level crates. If you're attempting something more custom, you might be interested in [`nostr`](../protocol/01-index.md) library.
File renamed without changes.

0 comments on commit cb56738

Please sign in to comment.