|
5 | 5 | <cap>Boundless: Verifiable Off-chain Computation on Any Chain</cap>
|
6 | 6 | </figure>
|
7 | 7 |
|
8 |
| -This Book's goal is to: |
| 8 | +## What's in this book? |
9 | 9 |
|
10 |
| -- Enable everyone to _understand_ [Boundless][term-boundless] via the [Market Section][page-market-overview] |
| 10 | +- Enable everyone to _understand_ [Boundless][term-boundless] via the [Market Section][page-boundless-market] |
11 | 11 | - Act as a User Manual for the two _actors_ in the [Boundless Market][term-boundless-market]:
|
12 | 12 | - [Requestors][term-requestor] - using the [Requestor Manual][page-requestor-manual]
|
13 | 13 | - [Provers][term-prover] - using the [Prover Manual][page-prover-manual]
|
14 | 14 |
|
15 |
| -Boundless is relatively complex in it's architecture and requires idiosyncratic terms to identify what is being referenced, defined in the [glossary][page-glossary]. |
| 15 | +## <i class="fa fa-magic"></i> Using this Book |
16 | 16 |
|
17 |
| -Helpful resources and more can be found in the [reference][page-reference]. |
| 17 | +This book is made with [mdBook](https://rust-lang.github.io/mdBook/) - a Rust native documentation tool. |
| 18 | +Please give the official docs there a read to see what nice features are included. |
| 19 | +To name a [few key items](https://rust-lang.github.io/mdBook/guide/reading.html#top-menu-bar): |
| 20 | + |
| 21 | +| Icon | Description | |
| 22 | +| --------------------------------- | ------------------------------------------------------------------------------- | |
| 23 | +| <i class="fa fa-bars"></i> | Opens and closes the chapter listing sidebar. | |
| 24 | +| <i class="fa fa-paint-brush"></i> | Opens a picker to choose a different color theme. | |
| 25 | +| <i class="fa fa-search"></i> | Opens a search bar for searching within the book. | |
| 26 | +| <i class="fa fa-github"></i> | Opens a link to the website that hosts the source code of the book. | |
| 27 | +| <i class="fa fa-edit"></i> | Opens a page to directly edit the source of the page you are currently reading. | |
| 28 | + |
| 29 | +### <i class="fa fa-arrows"></i> Navigation |
| 30 | + |
| 31 | +Use Arrow keys to:</br> |
| 32 | +<i class="fa fa-arrow-up"></i><i class="fa fa-arrow-down"></i> scroll the page</br> |
| 33 | +<i class="fa fa-arrow-left"></i><i class="fa fa-arrow-right"></i> jump to the previous or next page in the Books side-navigation bar, respectively |
| 34 | + |
| 35 | +### <i class="fa fa-search"></i> Search |
| 36 | + |
| 37 | +Pressing the search icon (<i class="fa fa-search"></i>) in the menu bar, or pressing `s` on the keyboard will open an input box for entering search terms. |
| 38 | +Typing some terms will show matching chapters, sections, and words in pages in real time. |
| 39 | + |
| 40 | +<i class="fa fa-arrow-up"></i><i class="fa fa-arrow-down"></i> arrows highlight & enter to jump or clicking any of the results will jump to that section. |
| 41 | +The up and down arrow keys can be used to navigate the results, and enter will open the highlighted section. |
| 42 | + |
| 43 | +After loading a search result, the matching search terms will be highlighted in the text. |
| 44 | +Clicking a highlighted word or pressing `Esc` will remove the highlighting. |
| 45 | + |
| 46 | +### <i class="fa fa-file-text-o"></i> Glossary & Reference |
| 47 | + |
| 48 | +Boundless is relatively complex in it's architecture and requires idiosyncratic concepts and terms defined in the [glossary][page-glossary]. |
| 49 | + |
| 50 | +Helpful resources and further reading can be found in the [reference][page-reference]. |
18 | 51 |
|
19 | 52 | [page-prover-manual]: prover-manual/README.md
|
20 |
| -[page-market-overview]: market/README.md |
| 53 | +[page-boundless-market]: market/README.md |
21 | 54 | [page-requestor-manual]: requestor-manual/README.md
|
22 | 55 | [page-glossary]: glossary.md
|
23 | 56 | [page-reference]: reference.md
|
|
0 commit comments