solana/doc
Greg Fitzgerald 8be7c13d2d
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
2018-11-06 18:00:58 -07:00
..
art Stub out architecture book (#1674) 2018-11-06 18:00:58 -07:00
src Stub out architecture book (#1674) 2018-11-06 18:00:58 -07:00
README.md Stub out architecture book (#1674) 2018-11-06 18:00:58 -07:00

README.md

Building the Solana book

Install mdbook:

cargo install mdbook

Run any Rust tests in the markdown:

mdbook test

Render markdown as HTML:

mdbook build

Render and view the book:

mdbook build --open