Skip to content

Commit 21d5716

Browse files
authored
BM-210: add a quick mdbook guide, use figure HTML element (github#43)
1 parent d4552fb commit 21d5716

File tree

5 files changed

+53
-15
lines changed

5 files changed

+53
-15
lines changed

docs/src/README.md

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,52 @@
55
<cap>Boundless: Verifiable Off-chain Computation on Any Chain</cap>
66
</figure>
77

8-
This Book's goal is to:
8+
## What's in this book?
99

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]
1111
- Act as a User Manual for the two _actors_ in the [Boundless Market][term-boundless-market]:
1212
- [Requestors][term-requestor] - using the [Requestor Manual][page-requestor-manual]
1313
- [Provers][term-prover] - using the [Prover Manual][page-prover-manual]
1414

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
1616

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].
1851

1952
[page-prover-manual]: prover-manual/README.md
20-
[page-market-overview]: market/README.md
53+
[page-boundless-market]: market/README.md
2154
[page-requestor-manual]: requestor-manual/README.md
2255
[page-glossary]: glossary.md
2356
[page-reference]: reference.md

docs/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
---
66

7-
- [💹 Market Overview](./market/README.md)
7+
- [💹 Market Docs](./market/README.md)
88

99
- [Boundless Market RFC](./market/rfc.md)
1010
- [Market Matching](./market/matching.md)

docs/src/market/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Market Overview
1+
# Market Documentation Overview
22

33
This section includes details pertinent to both:
44

docs/src/market/rfc.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@
44

55
Below is a diagram of the interaction flow assuming a user with a wallet is driving it.
66

7-
[https://excalidraw.com/#json=Dez07vdrpA3Hm4cX96jsF,qk9CxkIWC1AXOCN14KbQ6Q](https://excalidraw.com/#json=Dez07vdrpA3Hm4cX96jsF,qk9CxkIWC1AXOCN14KbQ6Q)
8-
9-
![Boundless market diagram](../images/boundless_market_diagram.png)
7+
<figure>
8+
<img src="../images/boundless_market_diagram.png"/>
9+
<cap>Boundless market diagram (<a href=https://excalidraw.com/#json=Dez07vdrpA3Hm4cX96jsF,qk9CxkIWC1AXOCN14KbQ6Q target=_blank>source</a>)</cap>
10+
</figure>
1011

1112
1. [Requestor][term-requestor] broadcasts their proof request to make it available to all provers.
1213
2. [Prover][term-prover] receives the request, attempts to fetch the [ELF binary][r0-term-elf-binary] with associated [Image ID][r0-term-image-id] and inputs, and evaluates it via preflight in the [executor][r0-term-executor]. Preflight allows the prover to know both that the request can actually be fulfilled and allows it to estimate the cost of proving. After evaluation, the prover will determine a price they would like to bid.
1314

1415
3. Prover sends a transaction to place their bid and lock-in the request. Upon lock-in, they have exclusive rights to be paid for the request, and must provide a requestor-specified amount of stake as collateral, burned in the event they fail to deliver a proof by the deadline.
1516
4. Prover produces the receipt:
16-
1. Proves the application [guest][] execution
17+
1. Proves the application [guest][r0-term-guest-program] execution
1718
2. Optionally aggregates the request into a batch via the set builder guest.
1819
3. Proves the request conditions are met via the Assessor guest.
1920
4. Adds the Assessor receipt to the batch via the set builder guest.
@@ -301,9 +302,10 @@ struct AssessorJournal {
301302

302303
After the Assessor is executed and proven, it is added to a running batch for efficient on-chain verification. A diagram showing the Merkle tree constructed by the set builder for aggregate verification.
303304

304-
[https://excalidraw.com/#json=7Zh4h6tXCY2mR2NLW8DvF,ixQZR3mEgm4Z5w6vtT86Xg](https://excalidraw.com/#json=7Zh4h6tXCY2mR2NLW8DvF,ixQZR3mEgm4Z5w6vtT86Xg)
305-
306-
![Assessor diagram](../images/assessor.png)
305+
<figure>
306+
<img src="../images/assessor.png"/>
307+
<cap>Assessor diagram (<a href=https://excalidraw.com/#json=7Zh4h6tXCY2mR2NLW8DvF,ixQZR3mEgm4Z5w6vtT86Xg target=_blank>source</a>)</cap>
308+
</figure>
307309

308310
[term-requestor]: ../glossary.md#requestor
309311
[term-prover]: ../glossary.md#prover

docs/src/prover-manual/bento/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ in its operation:
3737

3838
Bento's design philosophy is centered around TaskDB. TaskDB is a database schema in PostgreSQL that acts as a central communications hub, scheduler, and queue for all of the Bento system. To illustrate further, the following diagram is the visual representation of the proving workflow (RISC0 continuations).
3939

40-
![Bento Diagram](../../images/bento-diagram.png)
40+
<figure>
41+
<img src="../../images/bento-diagram.png"/>
42+
<cap>Bento Diagram</cap>
43+
</figure>
4144

4245
From there Bento has the application containers
4346

0 commit comments

Comments
 (0)