feat(docs): add the mdbook template

Signed-off-by: Vincenzo Palazzo <[email protected]>
vincenzopalazzo · Apr 13, 2023 · 8d56cc8 · 8d56cc8
1 parent 8f357b5
commit 8d56cc8
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 21 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+.idea
+*.log
+tmp/
+
+book
diff --git a/docs/book.toml b/docs/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Vincenzo Palazzo"]
+language = "en"
+multilingual = false
+src = "src"
+title = "One Day in cln4go API"
diff --git a/docs/MAINTAINERS.md → docs/src/MAINTAINERS.md b/docs/MAINTAINERS.md → docs/src/MAINTAINERS.md
@@ -107,7 +107,7 @@ The subject contains a succinct description of the change:
 ### Body
 
 You are free to put all the content you want inside the body, but if you are fixing
-an exception or some wrong behavior you must put the details or stacktrace inside the body ensure sure that
+an exception or some wrong behavior you must put the details or stacktrace inside the body ensure that
 the search engine indexes it.
 
 An example of commit body is the following one
@@ -128,30 +128,11 @@ description: "`Rust core lightning Rust framework` HACKING guide"
 ---
 ```
 
-## How to make the release
-
-This is the most fun part and also is the most difficult one in a monorepo repository.
-
-In particular, "core lightning Go Framework" has the possibility to release one single package at a time, or
-all together.
-
-To prepare for the release, these steps must be followed:
-
-- Bump the version number in the package before the release, and the version inside the `changelog.json` in the package root;
-    - Use a Personal Access Token or generate a [new one](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
-- Generate the changelog related to the package:
-    - `export GITHUB_TOKEN="your_token"`
-    - `make {changelog_rpc|changelog_plugin|changelog_common|changelog}`, where:
-        - `changelog_client`: generate the changelog for rpc library;
-        - `changelog_plugin`: generate the changelog for plugin module;
-        - `changelog_plugin_macros`: generate the changelog for common module.
-        - `changelog`: generate all changelogs.
-
 N.B: Part of this document is stolen from [core lightning](https://github.com/ElementsProject/lightning/blob/master/doc/HACKING.md) docs made with from @rustyrussell 's experience.
 
 >Programs must be written for people to read, and only incidentally for machines to execute.
 >                                                                            - Someone
 
 Cheers!
 
-[Vincent](https://github.com/vincenzopalazzo)
+[Vincent](https://github.com/vincenzopalazzo)
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -0,0 +1,8 @@
+# Summary
+
+- [Introduction](./chapter_1.md)
+- [cln4go Client](./client.md)
+- [cln4go Plugin](./plugin.md)
+- [cln4go common](./common.md)
+- [cln4go bench](./bench.md)
+- [Contributing](./MAINTAINERS.md)
diff --git a/docs/src/bench.md b/docs/src/bench.md
@@ -0,0 +1 @@
+# cln4go Benchmarks
diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md
@@ -0,0 +1 @@
+# Chapter 1
diff --git a/docs/src/client.md b/docs/src/client.md
@@ -0,0 +1,4 @@
+# cln4go client
+
+TODO introduce
+
diff --git a/docs/src/common.md b/docs/src/common.md
@@ -0,0 +1 @@
+# cln4go common
diff --git a/docs/src/plugin.md b/docs/src/plugin.md
@@ -0,0 +1 @@
+# cln4go Plugin