Stub out architecture book (#1674)

* Stub out architecture documentation

* Add book HTML generation and book tests to CI

* Add heading

* Better table of contents

* Reference existing documentation

Move ASCII art from code comments into rendered SVG

* Attempt to fix CI

* Add lamport docs

And truncate lines to 80 characters

* Fix links

And reference shorter, newer description of PoH.

* Replace ASCII art with SVG

* Streamline for Pillbox

* Update path before optional install

* Use $CARGO_HOME instead of $HOME

* Delete code

Attempt to describe all data structures without code.

* Boot RPU from docs, add JsonRpcService

Also, use Rust naming conventions in the block diagrams to
minimize the jump from docs to code.

* Latest code uses tick_height

* Rename bob/ folder to art/

A home for any ASCII art

* Import JSON RPC API

* More mdbook docs

* Add Ncp

* Cleanup links

* Move pipelining description into fullnode description

* Move high-level transaction docs into top-level doc

* Delete unused files
This commit is contained in:
Greg Fitzgerald
2018-11-06 18:00:58 -07:00
committed by GitHub
parent d7ea66b6a1
commit 8be7c13d2d
35 changed files with 2008 additions and 100 deletions

View File

@ -11,6 +11,18 @@ _() {
"$@"
}
maybe_install() {
for cmd in "$@"; do
set +e
"$cmd" --help > /dev/null 2>&1
declare exitcode=$?
set -e
if [[ $exitcode -ne 0 ]]; then
_ cargo install "$cmd"
fi
done
}
_ cargo fmt -- --check
_ cargo build --verbose
_ cargo test --verbose --lib
@ -33,6 +45,14 @@ for program in programs/native/*; do
)
done
# Build the HTML
export PATH=$CARGO_HOME/bin:$PATH
maybe_install mdbook
_ cd doc
_ mdbook test
_ mdbook build
_ cd -
echo --- ci/localnet-sanity.sh
(
set -x