From 0d39b289cb04af0681d2a0d32c55f6e9c9d5e709 Mon Sep 17 00:00:00 2001 From: xermicus Date: Sat, 8 Jun 2024 16:41:40 +0200 Subject: [PATCH] init mdbook Signed-off-by: xermicus --- .gitignore | 3 ++- Makefile | 8 +++++++- docs/.gitignore | 1 + docs/book.toml | 6 ++++++ docs/src/README.md | 3 +++ docs/src/SUMMARY.md | 13 +++++++++++++ docs/src/architecture.md | 1 + docs/src/cli.md | 1 + docs/src/development.md | 1 + docs/src/difference-evm.md | 1 + docs/src/differences-evm.md | 1 + docs/src/hardhat.md | 1 + docs/src/installation.md | 1 + docs/src/overview.md | 1 + docs/src/runtime.md | 3 +++ docs/src/user-guide.md | 1 + 16 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 docs/.gitignore create mode 100644 docs/book.toml create mode 100644 docs/src/README.md create mode 100644 docs/src/SUMMARY.md create mode 100644 docs/src/architecture.md create mode 100644 docs/src/cli.md create mode 100644 docs/src/development.md create mode 100644 docs/src/difference-evm.md create mode 100644 docs/src/differences-evm.md create mode 100644 docs/src/hardhat.md create mode 100644 docs/src/installation.md create mode 100644 docs/src/overview.md create mode 100644 docs/src/runtime.md create mode 100644 docs/src/user-guide.md diff --git a/.gitignore b/.gitignore index 4bc1957..be56afb 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,5 @@ node_modules artifacts tmp -package-lock.json \ No newline at end of file +package-lock.json +/*.html diff --git a/Makefile b/Makefile index 0eeb5f5..530913b 100644 --- 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 new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..10c7f95 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Cyrill Leutwiler "] +language = "en" +multilingual = false +src = "src" +title = "revive documentation" diff --git a/docs/src/README.md b/docs/src/README.md new file mode 100644 index 0000000..b89824c --- /dev/null +++ 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 new file mode 100644 index 0000000..8f1b324 --- /dev/null +++ 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 new file mode 100644 index 0000000..c79bec1 --- /dev/null +++ b/docs/src/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/src/cli.md b/docs/src/cli.md new file mode 100644 index 0000000..6a9c9ab --- /dev/null +++ b/docs/src/cli.md @@ -0,0 +1 @@ +# CLI guide diff --git a/docs/src/development.md b/docs/src/development.md new file mode 100644 index 0000000..459110d --- /dev/null +++ b/docs/src/development.md @@ -0,0 +1 @@ +# Development diff --git a/docs/src/difference-evm.md b/docs/src/difference-evm.md new file mode 100644 index 0000000..77b6f38 --- /dev/null +++ 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 new file mode 100644 index 0000000..77b6f38 --- /dev/null +++ b/docs/src/differences-evm.md @@ -0,0 +1 @@ +# Differences from EVM diff --git a/docs/src/hardhat.md b/docs/src/hardhat.md new file mode 100644 index 0000000..fe3b534 --- /dev/null +++ b/docs/src/hardhat.md @@ -0,0 +1 @@ +# Hardhat integration diff --git a/docs/src/installation.md b/docs/src/installation.md new file mode 100644 index 0000000..25267fe --- /dev/null +++ b/docs/src/installation.md @@ -0,0 +1 @@ +# Installation diff --git a/docs/src/overview.md b/docs/src/overview.md new file mode 100644 index 0000000..07dd0c5 --- /dev/null +++ b/docs/src/overview.md @@ -0,0 +1 @@ +# Overview diff --git a/docs/src/runtime.md b/docs/src/runtime.md new file mode 100644 index 0000000..d1ce326 --- /dev/null +++ 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 new file mode 100644 index 0000000..023ee7c --- /dev/null +++ b/docs/src/user-guide.md @@ -0,0 +1 @@ +# User guide