Initial commit - Basic templating

Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "ssv"
+version = "0.1.0"
+edition = "2021"
+author = "Sigma Prime"
+
+[dependencies]

README.md

@@ -1,2 +1,10 @@
-# ssv
-Rust implementation of the SSV protocol
+# SSV: Rust-based Secret Share Validator Client
+
+Open source implantation of the Secret Shared Validator (SSV) protocol, written
+in Rust and maintained by Sigma Prime.
+
+[Book Status]:https://img.shields.io/badge/user--docs-unstable-informational
+[Book Link]: https://ssv-book.sigmaprime.io
+[stable]: https://github.com/sigp/ssv/tree/stable
+[unstable]: https://github.com/sigp/ssv/tree/unstable
+[blog]: https://blog.sigmaprime.io

book/.gitignore

@@ -0,0 +1 @@
+book

book/.markdownlint.yml

@@ -0,0 +1,28 @@
+# MD010: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs
+MD010:
+  # Set code blocks to false so that code blocks will be ignored, default is true
+  code_blocks: false
+
+#MD013 line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+# Set to false as this will also interfere with help_x.md files, and it is not necessary to comply with the line length of 80
+MD013: false
+
+# MD028: set to false to allow blank line between blockquote: https://github.com/DavidAnson/markdownlint/blob/main/doc/md028.md
+# This is because the blockquotes are shown separatedly (a deisred outcome) when having a blank line in between
+MD028: false
+
+# MD024: set siblings_only to true so that same headings with different parent headings are allowed
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+MD024:
+  siblings_only: true
+
+# MD033 in-line html: https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
+# In-line html is fine in the markdown files, so this is set to false
+MD033: false
+
+# MD036 set to false to preserve the emphasis on deprecation notice on key-management.md (a heading is not necessary)
+MD036: false
+
+# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md
+# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change
+MD040: false

book/book.toml

@@ -0,0 +1,11 @@
+[book]
+language = "en"
+multilingual = false
+src = "src"
+title = "SSV Book"
+author = "Sigma Prime"
+
+[output.html]
+additional-css =["src/css/custom.css"]
+default-theme = "coal"
+

book/src/README.md

@@ -0,0 +1,17 @@
+# SSV Book
+
+Contains an [mdBook](https://github.com/rust-lang-nursery/mdBook) that serves
+as the primary source of SSV user documentation.
+
+The book is hosted at [ssv.sigmaprime.io](http://ssv.sigmaprime.io)
+
+## Usage
+
+The [mdBook docs](https://github.com/rust-lang-nursery/mdBook#usage) are the
+best source of information for building the book.
+
+### Example
+
+1. Install mdBook: `$ cargo install mdbook`
+1. Build the book, open it in a browser and build after file changes: `$ mdbook
+   serve --open`

book/src/SUMMARY.md

@@ -0,0 +1,5 @@
+# Summary
+
+* [Introduction](./intro.md)
+* [FAQs](./faq.md)
+* [Protocol Developers](./developers.md)

book/src/css/custom.css

@@ -0,0 +1,4 @@
+table {
+    margin: 0;
+    border-collapse: collapse;
+}

book/src/developers.md

@@ -0,0 +1,7 @@
+# For Protocol Developers
+
+_Documentation for protocol developers._
+
+This section lists Lighthouse-specific decisions that are not strictly spec'd and may be useful for
+other protocol developers wishing to interact with SSV.
+

book/src/faq.md

@@ -0,0 +1,7 @@
+# Frequently Asked Questions
+
+- [What is sigp/SSV](#sigp-ssv)
+
+### <a name="sigp-ssv"></a> What is sigp/SSV
+
+The rust implementation of the Secret Shared Validator (SSV) protocol.

book/src/intro.md

@@ -0,0 +1,13 @@
+# Lighthouse Book
+
+_Documentation for SSV users and developers._
+
+This is the SSV client. 
+
+## About this Book
+
+This book is open source, contribute at
+[github.com/sigp/ssv/book](https://github.com/sigp/ssv/tree/unstable/book).
+
+The SSV CI system maintains a hosted version of the `unstable` branch
+at [ssv-book.sigmaprime.io](http://ssv-book.sigmaprime.io).

src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}