docs: start docs mdbook

This commit is contained in:
nazeh
2024-07-22 10:46:14 +03:00
parent 5a6c7ae9c5
commit a9b92a58f5
9 changed files with 35 additions and 0 deletions

7
docs/src/SUMMARY.md Normal file
View File

@@ -0,0 +1,7 @@
# Summary
- [Overview](./overview.md)
- [Concepts](./concepts/README.md)
- [Root key](./concepts/rootkey.md)
- [Specifications](./spec/README.md)
- [Authn](./spec/authn.md)

1
docs/src/concepts.md Normal file
View File

@@ -0,0 +1 @@
# Concepts

View File

@@ -0,0 +1,3 @@
# Concepts
- [Root key](./rootkey.md)

View File

@@ -0,0 +1,3 @@
# Root key
A Root key is an Ed25519 public key, that represents the root of an identity in Pubky.

1
docs/src/overview.md Normal file
View File

@@ -0,0 +1 @@
# Overview

5
docs/src/spec/README.md Normal file
View File

@@ -0,0 +1,5 @@
# Specifications
Detail specifications of various aspects of the protocol.
- [Authn](./authn.md)

8
docs/src/spec/authn.md Normal file
View File

@@ -0,0 +1,8 @@
# Pubky Authn
Pubky Authn is a simple protocol for using user's [root key](../concepts/rootkey.md),
to authenticate themselves to a service provider.
## How it works
A client with access to the user's root key will begin by generating a time step and a nonce.