From e904793b7eb53bbf2dfd47dd15fa3597776858ad Mon Sep 17 00:00:00 2001
From: Youngjoon Lee <5462944+youngjoon-lee@users.noreply.github.com>
Date: Wed, 24 Apr 2024 23:18:51 +0900
Subject: [PATCH] Add mdBook skeleton (#640)

---
 book/.gitignore                       |  1 +
 book/README.md                        |  6 ++++++
 book/book.toml                        |  6 ++++++
 book/src/SUMMARY.md                   |  7 +++++++
 book/src/installation/docker.md       | 22 ++++++++++++++++++++++
 book/src/installation/installation.md |  7 +++++++
 book/src/installation/source.md       |  1 +
 book/src/introduction.md              |  1 +
 book/src/run-nodes.md                 | 11 +++++++++++
 book/src/run-nodes/run-nodes.md       |  1 +
 10 files changed, 63 insertions(+)
 create mode 100644 book/.gitignore
 create mode 100644 book/README.md
 create mode 100644 book/book.toml
 create mode 100644 book/src/SUMMARY.md
 create mode 100644 book/src/installation/docker.md
 create mode 100644 book/src/installation/installation.md
 create mode 100644 book/src/installation/source.md
 create mode 100644 book/src/introduction.md
 create mode 100644 book/src/run-nodes.md
 create mode 100644 book/src/run-nodes/run-nodes.md

diff --git a/book/.gitignore b/book/.gitignore
new file mode 100644
index 00000000..7585238e
--- /dev/null
+++ b/book/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/book/README.md b/book/README.md
new file mode 100644
index 00000000..e69daeb1
--- /dev/null
+++ b/book/README.md
@@ -0,0 +1,6 @@
+# Nomos Node Book
+
+To build the book and view it in your browser, run the following command:
+```bash
+mdbook serve --open
+```
diff --git a/book/book.toml b/book/book.toml
new file mode 100644
index 00000000..509c2d59
--- /dev/null
+++ b/book/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = []
+language = "en"
+multilingual = false
+src = "src"
+title = "Nomos Node"
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
new file mode 100644
index 00000000..c24143ed
--- /dev/null
+++ b/book/src/SUMMARY.md
@@ -0,0 +1,7 @@
+# Summary
+
+- [Introduction](./introduction.md)
+- [Installation](./installation/installation.md)
+  - [Docker image](./installation/docker.md)
+  - [Building from source](./installation/source.md)
+- [Run Nodes](./run-nodes.md)
diff --git a/book/src/installation/docker.md b/book/src/installation/docker.md
new file mode 100644
index 00000000..56a5039e
--- /dev/null
+++ b/book/src/installation/docker.md
@@ -0,0 +1,22 @@
+# Installation using Docker
+
+## Building the Docker image
+
+To build the Docker image, run the following command at the root of the project:
+```bash
+docker build -t nomos .
+```
+
+## Using the Docker image
+
+You can run a Nomos node using the Docker image by running the following command:
+```bash
+docker run nomos /etc/nomos/config.yml
+```
+
+To run a node with a different configuration run:
+```bash
+docker run -v /path/to/config.yml:/etc/nomos/config.yml nomos /etc/nomos/config.yml
+```
+
+For more detailed instructions to configure and run Nomos nodes, refer to the [Run Nodes](../run-nodes.md).
diff --git a/book/src/installation/installation.md b/book/src/installation/installation.md
new file mode 100644
index 00000000..1ec26e10
--- /dev/null
+++ b/book/src/installation/installation.md
@@ -0,0 +1,7 @@
+# Installation
+
+Nomos Node runs on Linux, macOS, and Windows.
+
+There are several ways to install Nomos Node:
+- [Docker image](./docker.md)
+- [Building from source](./source.md)
diff --git a/book/src/installation/source.md b/book/src/installation/source.md
new file mode 100644
index 00000000..6a5b9dc1
--- /dev/null
+++ b/book/src/installation/source.md
@@ -0,0 +1 @@
+# Building from source
diff --git a/book/src/introduction.md b/book/src/introduction.md
new file mode 100644
index 00000000..07778257
--- /dev/null
+++ b/book/src/introduction.md
@@ -0,0 +1 @@
+# Nomos Node
diff --git a/book/src/run-nodes.md b/book/src/run-nodes.md
new file mode 100644
index 00000000..9e207288
--- /dev/null
+++ b/book/src/run-nodes.md
@@ -0,0 +1,11 @@
+# Run Nomos Nodes
+
+This section provides instructions to configure and run multiple Nomos nodes.
+You should read with the [Installation](../installation/installation.md) section before proceeding.
+
+## Configuration
+
+A Nomos node is configured using a configuration file (YAML).
+If you are running a node using the Docker image, the config file is contained in the image (`/etc/nomos/config.yml`).
+
+TODO
diff --git a/book/src/run-nodes/run-nodes.md b/book/src/run-nodes/run-nodes.md
new file mode 100644
index 00000000..e1557a6f
--- /dev/null
+++ b/book/src/run-nodes/run-nodes.md
@@ -0,0 +1 @@
+# Run Nodes