|
1 |
| -## Current intention |
2 |
| - |
3 |
| -The current work aims at creating a progressive learning experience into writing Smart Contracts as proposed by Agoric. An attention is given to provide a very simple first experience and increase the complexity gradually |
4 |
| - |
5 |
| -Identified sources of complexity: |
6 |
| -- How contracts can be expressed |
7 |
| - - Jessie |
8 |
| -- What can be expressed in contracts |
9 |
| - - multi-party contracts with invites |
10 |
| - - turn-based contracts |
11 |
| - - ERTP framework |
12 |
| - - ContractHost |
13 |
| - - Escrow |
14 |
| - - CoveredCall |
15 |
| - - hierarchical rights |
16 |
| - - non-determinism (time, randomness)? |
17 |
| -- Infrastructure/Tooling |
18 |
| - - @agoric npm packages |
19 |
| - - User interface |
20 |
| - - Vats |
21 |
| - - Swingset |
22 |
| - - Cosmic-Swingset |
23 |
| - |
24 |
| - |
25 |
| -### Progress |
26 |
| - |
27 |
| -Progress can be followed [on this |
28 |
| -board](https://github.com/Agoric/documentation/projects/1?fullscreen=true) |
| 1 | +## Build Locally |
| 2 | + |
| 3 | +To run a local server to see the changes in real time, run: |
| 4 | + |
| 5 | +```shell |
| 6 | +npm run docs:dev |
| 7 | +``` |
| 8 | + |
| 9 | +Note that changes to the site config may require stopping this program |
| 10 | +and restarting. |
| 11 | + |
| 12 | +To build the site as it will be built for production, run: |
| 13 | + |
| 14 | +```shell |
| 15 | +npm run docs:build |
| 16 | +``` |
| 17 | + |
| 18 | +## Github Actions and Continuous Integration |
| 19 | + |
| 20 | +On every pull request and on every commit to master, the following |
| 21 | +Github Actions run: |
| 22 | + |
| 23 | +* Test the build - tests that a build does not error and that the |
| 24 | + result passes html5 validation |
| 25 | +* Spellcheck - checks against a dictionary and a local wordlist |
| 26 | + |
| 27 | +## Spellcheck |
| 28 | + |
| 29 | +This is currently only available in Github Actions on Pull Requests. |
| 30 | +Any words that do not pass spell check will be shown in the logs of |
| 31 | +the Github Action. Please either fix the words or add them to the list |
| 32 | +in `.wordlist.txt`. |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +## Check Links |
| 37 | + |
| 38 | +This is not yet hooked up to continuous integration, but to check the |
| 39 | +internal Vuepress links locally (this does not test external links or |
| 40 | +router-links), run: |
| 41 | + |
| 42 | +```shell |
| 43 | +npm run check-links |
| 44 | +``` |
| 45 | + |
| 46 | +Links should be relative and in [this format](https://vuepressbook.com/tutorial/tutorial2.html#linking-to-headers-inside-a-file). |
| 47 | + |
0 commit comments