init mdbook

Signed-off-by: xermicus <[email protected]>
paritytech · Jun 8, 2024 · 0d39b28 · 0d39b28
1 parent 10c7045
commit 0d39b28
Show file tree

Hide file tree

Showing 16 changed files with 44 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,4 +11,5 @@
 node_modules
 artifacts
 tmp
-package-lock.json
+package-lock.json
+/*.html
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: install format test test-solidity test-cli test-integration test-workspace clean
+.PHONY: install format test test-solidity test-cli test-integration test-workspace clean docs docs-build
 
 install: install-bin install-npm
 
@@ -48,6 +48,12 @@ bench: install-bin
 clippy:
 	cargo clippy --all-features --workspace --tests --benches
 
+docs: docs-build
+	mdbook serve --open docs/
+
+docs-build:
+	mdbook test docs/ && mdbook build docs/
+
 clean:
 	cargo clean ; \
 	rm -rf node_modules ; \

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/book.toml b/docs/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Cyrill Leutwiler <[email protected]>"]
+language = "en"
+multilingual = false
+src = "src"
+title = "revive documentation"
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -0,0 +1,3 @@
+# revive documentation
+
+Welcome to the revive Solidty compiler documentation!
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -0,0 +1,13 @@
+# Summary
+
+[Introduction](README.md)
+
+- [User guide](./user-guide.md)
+    - [Installation](./installation.md)
+    - [CLI guide](./cli.md)
+    - [Hardhat integration](./hardhat.md)
+- [Architecture](./architecture.md)
+    - [Overview](./overview.md)
+    - [Runtime](./runtime.md)
+    - [Differences from EVM](./differences-evm.md)
+- [Development](./development.md)
diff --git a/docs/src/architecture.md b/docs/src/architecture.md
@@ -0,0 +1 @@
+# Architecture
diff --git a/docs/src/cli.md b/docs/src/cli.md
@@ -0,0 +1 @@
+# CLI guide
diff --git a/docs/src/development.md b/docs/src/development.md
@@ -0,0 +1 @@
+# Development
diff --git a/docs/src/difference-evm.md b/docs/src/difference-evm.md
@@ -0,0 +1 @@
+# Differences from EVM
diff --git a/docs/src/differences-evm.md b/docs/src/differences-evm.md
@@ -0,0 +1 @@
+# Differences from EVM
diff --git a/docs/src/hardhat.md b/docs/src/hardhat.md
@@ -0,0 +1 @@
+# Hardhat integration
diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/src/overview.md b/docs/src/overview.md
@@ -0,0 +1 @@
+# Overview
diff --git a/docs/src/runtime.md b/docs/src/runtime.md
@@ -0,0 +1,3 @@
+# Runtime
+
+revive compiled contract target the new contracts pallet runtime environment API.
diff --git a/docs/src/user-guide.md b/docs/src/user-guide.md
@@ -0,0 +1 @@
+# User guide