diff --git a/.gitignore b/.gitignore index a0c6d82c9b..c2853f0db9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ /target/ -/book/ +/book/html/ **/*.rs.bk .cargo diff --git a/README.md b/README.md index eb35a60308..c5ce89d86f 100644 --- a/README.md +++ b/README.md @@ -73,19 +73,19 @@ cargo install mdbook Run any Rust tests in the markdown: ```bash -mdbook test +mdbook test book ``` Render markdown as HTML: ```bash -mdbook build +mdbook build book ``` Render and view the book: ```bash -mdbook build --open +mdbook build --open book ``` diff --git a/book.toml b/book.toml deleted file mode 100644 index bde186740b..0000000000 --- a/book.toml +++ /dev/null @@ -1,2 +0,0 @@ -[book] -title = "Solana: Blockchain Rebuilt for Scale" diff --git a/art/consensus.msc b/book/art/consensus.msc similarity index 100% rename from art/consensus.msc rename to book/art/consensus.msc diff --git a/art/fullnode.bob b/book/art/fullnode.bob similarity index 100% rename from art/fullnode.bob rename to book/art/fullnode.bob diff --git a/art/leader-scheduler.bob b/book/art/leader-scheduler.bob similarity index 100% rename from art/leader-scheduler.bob rename to book/art/leader-scheduler.bob diff --git a/art/runtime.bob b/book/art/runtime.bob similarity index 100% rename from art/runtime.bob rename to book/art/runtime.bob diff --git a/art/sdk-tools.bob b/book/art/sdk-tools.bob similarity index 100% rename from art/sdk-tools.bob rename to book/art/sdk-tools.bob diff --git a/art/tpu.bob b/book/art/tpu.bob similarity index 100% rename from art/tpu.bob rename to book/art/tpu.bob diff --git a/art/tvu.bob b/book/art/tvu.bob similarity index 100% rename from art/tvu.bob rename to book/art/tvu.bob diff --git a/book/book.toml b/book/book.toml new file mode 100644 index 0000000000..393ae59e02 --- /dev/null +++ b/book/book.toml @@ -0,0 +1,8 @@ +[book] +title = "Solana: Blockchain Rebuilt for Scale" + +[build] +build-dir = "html" +create-missing = false + +[output.html] diff --git a/src/SUMMARY.md b/book/src/SUMMARY.md similarity index 100% rename from src/SUMMARY.md rename to book/src/SUMMARY.md diff --git a/src/appendix.md b/book/src/appendix.md similarity index 100% rename from src/appendix.md rename to book/src/appendix.md diff --git a/src/avalanche.md b/book/src/avalanche.md similarity index 100% rename from src/avalanche.md rename to book/src/avalanche.md diff --git a/src/cluster.md b/book/src/cluster.md similarity index 100% rename from src/cluster.md rename to book/src/cluster.md diff --git a/src/fullnode.md b/book/src/fullnode.md similarity index 100% rename from src/fullnode.md rename to book/src/fullnode.md diff --git a/src/getting-started.md b/book/src/getting-started.md similarity index 100% rename from src/getting-started.md rename to book/src/getting-started.md diff --git a/src/img/fullnode.svg b/book/src/img/fullnode.svg similarity index 100% rename from src/img/fullnode.svg rename to book/src/img/fullnode.svg diff --git a/src/img/leader-scheduler.svg b/book/src/img/leader-scheduler.svg similarity index 100% rename from src/img/leader-scheduler.svg rename to book/src/img/leader-scheduler.svg diff --git a/src/img/runtime.svg b/book/src/img/runtime.svg similarity index 100% rename from src/img/runtime.svg rename to book/src/img/runtime.svg diff --git a/src/img/sdk-tools.svg b/book/src/img/sdk-tools.svg similarity index 100% rename from src/img/sdk-tools.svg rename to book/src/img/sdk-tools.svg diff --git a/src/img/tpu.svg b/book/src/img/tpu.svg similarity index 100% rename from src/img/tpu.svg rename to book/src/img/tpu.svg diff --git a/src/img/tvu.svg b/book/src/img/tvu.svg similarity index 100% rename from src/img/tvu.svg rename to book/src/img/tvu.svg diff --git a/src/introduction.md b/book/src/introduction.md similarity index 100% rename from src/introduction.md rename to book/src/introduction.md diff --git a/src/jsonrpc-api.md b/book/src/jsonrpc-api.md similarity index 100% rename from src/jsonrpc-api.md rename to book/src/jsonrpc-api.md diff --git a/src/jsonrpc-service.md b/book/src/jsonrpc-service.md similarity index 100% rename from src/jsonrpc-service.md rename to book/src/jsonrpc-service.md diff --git a/src/leader-scheduler.md b/book/src/leader-scheduler.md similarity index 100% rename from src/leader-scheduler.md rename to book/src/leader-scheduler.md diff --git a/src/ncp.md b/book/src/ncp.md similarity index 100% rename from src/ncp.md rename to book/src/ncp.md diff --git a/src/poh.md b/book/src/poh.md similarity index 100% rename from src/poh.md rename to book/src/poh.md diff --git a/src/programs.md b/book/src/programs.md similarity index 100% rename from src/programs.md rename to book/src/programs.md diff --git a/src/runtime.md b/book/src/runtime.md similarity index 100% rename from src/runtime.md rename to book/src/runtime.md diff --git a/src/storage.md b/book/src/storage.md similarity index 100% rename from src/storage.md rename to book/src/storage.md diff --git a/src/synchronization.md b/book/src/synchronization.md similarity index 100% rename from src/synchronization.md rename to book/src/synchronization.md diff --git a/src/terminology.md b/book/src/terminology.md similarity index 100% rename from src/terminology.md rename to book/src/terminology.md diff --git a/src/tpu.md b/book/src/tpu.md similarity index 100% rename from src/tpu.md rename to book/src/tpu.md diff --git a/src/tvu.md b/book/src/tvu.md similarity index 100% rename from src/tvu.md rename to book/src/tvu.md diff --git a/src/vdf.md b/book/src/vdf.md similarity index 100% rename from src/vdf.md rename to book/src/vdf.md diff --git a/src/wallet.md b/book/src/wallet.md similarity index 100% rename from src/wallet.md rename to book/src/wallet.md diff --git a/ci/publish-book.sh b/ci/publish-book.sh index 00ab666250..85850c6bbf 100755 --- a/ci/publish-book.sh +++ b/ci/publish-book.sh @@ -22,13 +22,13 @@ maybe_install() { export PATH=$CARGO_HOME/bin:$PATH maybe_install mdbook -_ mdbook test -_ mdbook build +_ mdbook test book +_ mdbook build book echo --- create book repo ( set -x - cd book/ + cd book/html/ git init . git config user.email "maintainers@solana.com" git config user.name "$(basename "$0")" @@ -40,7 +40,7 @@ echo --- publish if [[ $BUILDKITE_BRANCH = master ]]; then ( set -x - cd book/ + cd book/html/ git remote add origin git@github.com:solana-labs/solana.git git push -f origin HEAD:gh-pages ) diff --git a/ci/test-stable.sh b/ci/test-stable.sh index a8eac5ab9c..4be3c91d59 100755 --- a/ci/test-stable.sh +++ b/ci/test-stable.sh @@ -47,8 +47,8 @@ done # Build the HTML export PATH=$CARGO_HOME/bin:$PATH maybe_install mdbook -_ mdbook test -_ mdbook build +_ mdbook test book +_ mdbook build book echo --- ci/localnet-sanity.sh (