From 895d5fea41177e444c18f4fdc820fffa5f67d5bf Mon Sep 17 00:00:00 2001 From: Rasmus Dahlberg Date: Sat, 9 Dec 2023 17:08:45 +0100 Subject: Add drafty skeleton --- docs/architecture.md | 3 +++ docs/server.md | 8 ++++++++ docs/state.md | 9 +++++++++ 3 files changed, 20 insertions(+) create mode 100644 docs/architecture.md create mode 100644 docs/server.md create mode 100644 docs/state.md (limited to 'docs') diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..8f562cb --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,3 @@ +# Architecture + +docdoc diff --git a/docs/server.md b/docs/server.md new file mode 100644 index 0000000..51a5ec4 --- /dev/null +++ b/docs/server.md @@ -0,0 +1,8 @@ +# Server API + +docdoc + +## Authentication +## Endpoints +### get-status +### add-chain diff --git a/docs/state.md b/docs/state.md new file mode 100644 index 0000000..fbb965d --- /dev/null +++ b/docs/state.md @@ -0,0 +1,9 @@ +# State + +All state is managed by the silent-ct [manager](../internal/manager). All such +state is persisted to disk in a common directory as a collection of files. Not +having any database simplifies setup and manual debugging, should it be needed. + +## Structure of the state directory + +docdoc -- cgit v1.2.3