From a9b92a58f57647a5c74014baa188fcc0ecde6efa Mon Sep 17 00:00:00 2001 From: nazeh Date: Mon, 22 Jul 2024 10:46:14 +0300 Subject: [PATCH] docs: start docs mdbook --- docs/.gitignore | 1 + docs/book.toml | 6 ++++++ docs/src/SUMMARY.md | 7 +++++++ docs/src/concepts.md | 1 + docs/src/concepts/README.md | 3 +++ docs/src/concepts/rootkey.md | 3 +++ docs/src/overview.md | 1 + docs/src/spec/README.md | 5 +++++ docs/src/spec/authn.md | 8 ++++++++ 9 files changed, 35 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/book.toml create mode 100644 docs/src/SUMMARY.md create mode 100644 docs/src/concepts.md create mode 100644 docs/src/concepts/README.md create mode 100644 docs/src/concepts/rootkey.md create mode 100644 docs/src/overview.md create mode 100644 docs/src/spec/README.md create mode 100644 docs/src/spec/authn.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..e645fab --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["nuh.dev"] +language = "en" +multilingual = false +src = "src" +title = "Pubky" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000..31f4e04 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -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) diff --git a/docs/src/concepts.md b/docs/src/concepts.md new file mode 100644 index 0000000..74d42e1 --- /dev/null +++ b/docs/src/concepts.md @@ -0,0 +1 @@ +# Concepts diff --git a/docs/src/concepts/README.md b/docs/src/concepts/README.md new file mode 100644 index 0000000..da1d7a0 --- /dev/null +++ b/docs/src/concepts/README.md @@ -0,0 +1,3 @@ +# Concepts + +- [Root key](./rootkey.md) diff --git a/docs/src/concepts/rootkey.md b/docs/src/concepts/rootkey.md new file mode 100644 index 0000000..0ef0933 --- /dev/null +++ b/docs/src/concepts/rootkey.md @@ -0,0 +1,3 @@ +# Root key + +A Root key is an Ed25519 public key, that represents the root of an identity in Pubky. diff --git a/docs/src/overview.md b/docs/src/overview.md new file mode 100644 index 0000000..07dd0c5 --- /dev/null +++ b/docs/src/overview.md @@ -0,0 +1 @@ +# Overview diff --git a/docs/src/spec/README.md b/docs/src/spec/README.md new file mode 100644 index 0000000..e784564 --- /dev/null +++ b/docs/src/spec/README.md @@ -0,0 +1,5 @@ +# Specifications + +Detail specifications of various aspects of the protocol. + +- [Authn](./authn.md) diff --git a/docs/src/spec/authn.md b/docs/src/spec/authn.md new file mode 100644 index 0000000..7da8fe3 --- /dev/null +++ b/docs/src/spec/authn.md @@ -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.