Skip to content

Commit d62758b

Browse files
katelynsillskatelynsills
authored
chore: add html5 validator to CI (#304)
* chore: add html5 validator to CI * chore: update path * fix: remove <center> * fix: fix invalid html5 code * fix: <th> should be in <thead> * chore: more fixes
1 parent 3489ebc commit d62758b

File tree

6 files changed

+132
-126
lines changed

6 files changed

+132
-126
lines changed

‎.github/workflows/test-build.yml

+6
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,9 @@ jobs:
1919
run: |
2020
npm install
2121
npm run docs:build
22+
23+
- name: HTML5 Validator
24+
uses: Cyb3r-Jak3/html5validator-action@master
25+
with:
26+
root: main/.vuepress/dist
27+

‎main/.vuepress/components/Button-Action-Link.vue

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
<template>
2-
<router-link :to="link">
3-
<button
4-
class="ag-btn ag-btn--large"
5-
type="button"
6-
>
7-
{{ text }}
8-
</button>
2+
<router-link tag="button" class="ag-btn ag-btn--large" :to="link">
3+
{{ text }}
94
</router-link>
105
</template>
116

‎main/getting-started/before-using-agoric.md

+90-86
Original file line numberDiff line numberDiff line change
@@ -4,93 +4,97 @@
44
Before working with the Agoric CLI, Zoe, and other Agoric tools and
55
software, you need to install the following.
66

7-
<table border="1">
7+
<table>
8+
<thead>
9+
<tr>
10+
<th><b>Step</b></th>
11+
<th><b>Action</b></th>
12+
<th><b>Explanation</b></th>
13+
</tr>
14+
</thead>
815
<tbody>
9-
<th><b>Step</b></th>
10-
<th><b>Action</b></th>
11-
<th><b>Explanation</b></th>
12-
<tr>
13-
<td><center>0</center></td>
14-
<td>Use a Unix-like environment</td>
15-
<td>You will need to type commands at a Bash-like shell command line prompt,
16-
such as is found in <a href="https://en.wikipedia.org/wiki/Linux">Linux</a>,
17-
(<a href="https://www.apple.com/macos/">MacOS</a>, or
18-
<a href="https://docs.microsoft.com/en-us/windows/wsl/">Windows Subsystem for Linux (wsl)</a>.</td>
19-
<tr>
20-
<td><center>1</center></td>
21-
<td><a href="https://nodejs.org/">Install Node.js</a>, version 12.16.1 or higher</td>
22-
<td></td>
23-
</tr>
24-
<tr>
25-
<td><center>2</center></td>
26-
<td><a href="https://classic.yarnpkg.com/en/docs/install">Install Yarn 1<br>(Yes, Yarn 1 and not a later version)</a></td>
27-
<td>Yarn is a package manager for your code and lets developers
28-
share code with others. Code is shared via a <i>package</i> that contains all shared code and a
29-
<code>package.json</code> file describing the package. The link takes you to
30-
the Yarn install page, where you first select what operating system you want to
31-
install on. Your selection changes the page's content to give install instructions for that
32-
OS and links to the needed downloads.</td>
33-
</tr>
34-
<tr>
35-
<td><center>3</center></td>
36-
<td>Open a shell. The rest of this table's Actions take place in
37-
this shell.</td>
38-
<td><ul><li>A terminal on Macs; see
39-
<b>Finder&gt;Applications&gt;Utilities&gt;terminal</b></li>
40-
<li>To launch a bash shell at a specific folder on Windows 10:
41-
<ol><li>Navigate to that folder in File Explorer.</li>
42-
<li>Click the address bar while in that folder.</li>
43-
<li>Type <code>bash</code> in the address bar and press <b>Enter</b>
44-
</li></ol></li></ul>
45-
</td>
46-
</tr>
47-
<tr>
48-
<td><center>4</center></td>
49-
<td>If you already have a <code>~/agoric-sdk</code> directory, update it:
50-
<br><code>cd agoric-sdk</code>
51-
<br><code>git checkout master</code>
52-
<br><code>git pull</code>
53-
</td>
54-
<td>In the next step, if you don't have a copy of our <code>agoric-sdk</code> directory, you'll get one. This is in case you already have one and might need to update it.</td>
55-
</tr>
56-
<tr>
57-
<td><center>5</center></td>
58-
<td>If you don't have an <code>~/agoric-sdk</code> directory with Agoric's SDK content in it,
59-
<code>git clone https://github.com/Agoric/agoric-sdk</code></td>
60-
<td>Get the latest Agoric SDK from the Agoric GitHub
61-
repository. It goes into the
62-
<code>agoric-sdk</code> sub-directory of your home directory.
63-
If the <code>agoric-sdk</code> sub-directory doesn't already exist,
64-
this operation creates it.
65-
</td>
66-
</tr>
67-
<tr>
68-
<td><center>6</center></td>
69-
<td><code>cd ~/agoric-sdk</code></td>
70-
<td>Change to the <code>agoric-sdk</code> subdirectory in your home
71-
directory.</td>
72-
</tr>
73-
<tr>
74-
<td><center>7</center></td>
75-
<td><code>yarn install</code></td>
76-
<td>Install NPM dependencies.</td>
77-
</tr>
78-
<tr>
79-
<td><center>8</center></td>
80-
<td><code>yarn build</code></td>
81-
<td>Build sources that need compiling. <b>Note:</b>
82-
<code>build</code> is not a standard <code>yarn</code> command,
83-
but one installed with the Agoric SDK.</td>
84-
</tr>
85-
<tr>
86-
<td><center>9</center></td>
87-
<td>Install the Agoric CLI by: <code>yarn link-cli
88-
&lt;<i>agoric script location</i>&gt;</code></td>
89-
<td>Select a location for the Agoric CLI program. For example,
90-
<code>yarn link-cli /usr/local/bin/agoric</code> (or if that fails
91-
with permission problems, <code>sudo yarn link-cli /usr/local/bin/agoric</code>)
16+
<tr>
17+
<td>0</td>
18+
<td>Use a Unix-like environment</td>
19+
<td>You will need to type commands at a Bash-like shell command line prompt,
20+
such as is found in <a href="https://en.wikipedia.org/wiki/Linux">Linux</a>,
21+
(<a href="https://www.apple.com/macos/">MacOS</a>, or
22+
<a href="https://docs.microsoft.com/en-us/windows/wsl/">Windows Subsystem for Linux (wsl)</a>.</td>
23+
<tr>
24+
<td>1</td>
25+
<td><a href="https://nodejs.org/">Install Node.js</a>, version 12.16.1 or higher</td>
26+
<td></td>
27+
</tr>
28+
<tr>
29+
<td>2</td>
30+
<td><a href="https://classic.yarnpkg.com/en/docs/install">Install Yarn 1<br>(Yes, Yarn 1 and not a later version)</a></td>
31+
<td>Yarn is a package manager for your code and lets developers
32+
share code with others. Code is shared via a <i>package</i> that contains all shared code and a
33+
<code>package.json</code> file describing the package. The link takes you to
34+
the Yarn install page, where you first select what operating system you want to
35+
install on. Your selection changes the page's content to give install instructions for that
36+
OS and links to the needed downloads.</td>
37+
</tr>
38+
<tr>
39+
<td>3</td>
40+
<td>Open a shell. The rest of this table's Actions take place in
41+
this shell.</td>
42+
<td><ul><li>A terminal on Macs; see
43+
<b>Finder&gt;Applications&gt;Utilities&gt;terminal</b></li>
44+
<li>To launch a bash shell at a specific folder on Windows 10:
45+
<ol><li>Navigate to that folder in File Explorer.</li>
46+
<li>Click the address bar while in that folder.</li>
47+
<li>Type <code>bash</code> in the address bar and press <b>Enter</b>
48+
</li></ol></li></ul>
9249
</td>
93-
</tr>
94-
</tbody>
50+
</tr>
51+
<tr>
52+
<td>4</td>
53+
<td>If you already have a <code>~/agoric-sdk</code> directory, update it:
54+
<br><code>cd agoric-sdk</code>
55+
<br><code>git checkout master</code>
56+
<br><code>git pull</code>
57+
</td>
58+
<td>In the next step, if you don't have a copy of our <code>agoric-sdk</code> directory, you'll get one. This is in case you already have one and might need to update it.</td>
59+
</tr>
60+
<tr>
61+
<td>5</td>
62+
<td>If you don't have an <code>~/agoric-sdk</code> directory with Agoric's SDK content in it,
63+
<code>git clone https://github.com/Agoric/agoric-sdk</code></td>
64+
<td>Get the latest Agoric SDK from the Agoric GitHub
65+
repository. It goes into the
66+
<code>agoric-sdk</code> sub-directory of your home directory.
67+
If the <code>agoric-sdk</code> sub-directory doesn't already exist,
68+
this operation creates it.
69+
</td>
70+
</tr>
71+
<tr>
72+
<td>6</td>
73+
<td><code>cd ~/agoric-sdk</code></td>
74+
<td>Change to the <code>agoric-sdk</code> subdirectory in your home
75+
directory.</td>
76+
</tr>
77+
<tr>
78+
<td>7</td>
79+
<td><code>yarn install</code></td>
80+
<td>Install NPM dependencies.</td>
81+
</tr>
82+
<tr>
83+
<td>8</td>
84+
<td><code>yarn build</code></td>
85+
<td>Build sources that need compiling. <b>Note:</b>
86+
<code>build</code> is not a standard <code>yarn</code> command,
87+
but one installed with the Agoric SDK.</td>
88+
</tr>
89+
<tr>
90+
<td>9</td>
91+
<td>Install the Agoric CLI by: <code>yarn link-cli
92+
&lt;<i>agoric script location</i>&gt;</code></td>
93+
<td>Select a location for the Agoric CLI program. For example,
94+
<code>yarn link-cli /usr/local/bin/agoric</code> (or if that fails
95+
with permission problems, <code>sudo yarn link-cli /usr/local/bin/agoric</code>)
96+
</td>
97+
</tr>
98+
</tbody>
9599
</table>
96100

‎main/getting-started/development-cycle.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ Then go to that row's second column and do the action specified there. You then
88

99
You don’t have to do any of the second column actions in rows above where you started.
1010

11-
<table border="1">
11+
<table>
1212
<tbody>
1313
<tr>
14-
<td colspan="3"><b>How to use this table:<br><br>
15-
<ol><li>Go down the first column until you encounter the type of change you made.</li>
16-
<li>Go to that row’s second column and do the action specified there (if you want to know more about what and why you’re doing, see the row’s third column).</li>
17-
<li>Go down to the next row and do the action in its second column.</li>
18-
<li>Repeat 3. until you reach the bottom of the table and do the action in the bottom row’s second column.</li>
19-
</ol></b>
14+
<td colspan="3"><b>How to use this table:</b><br><br>
15+
<ol><li><b>Go down the first column until you encounter the type of change you made.</b></li>
16+
<li><b>Go to that row’s second column and do the action specified there (if you want to know more about what and why you’re doing, see the row’s third column).</b></li>
17+
<li><b>Go down to the next row and do the action in its second column.</b></li>
18+
<li><b>Repeat 3. until you reach the bottom of the table and do the action in the bottom row’s second column.</b></li>
19+
</ol>
2020
For example, let’s say you changed code in <code>agoric-sdk</code>. Going down the first column, you find it and look at the action in the second column of that row. It says you need to run <code>agoric start --reset</code>. Then go to the next row and its second column to find out you need to run <code>agoric deploy contract/deploy.js</code> Continue doing the action specified in each following row’s second column until the “refresh your browser” instruction in the bottom row.
2121
</td>
2222
</tr>
2323
<tr>
24-
<th><center><b>If you...</b></center></td></th>
25-
<th><center><b>Then you must...</b></center></td></th>
26-
<th><center><b>Notes</b></center></td></th>
24+
<th><b>If you...</b></td></th>
25+
<th><b>Then you must...</b></td></th>
26+
<th><b>Notes</b></td></th>
2727
</tr>
2828
<tr>
2929
<td>Change which npm packages are used in <code>agoric-sdk</code></td>

‎main/getting-started/intro-zoe.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -298,55 +298,55 @@ The following table summarizes an Atomic Swap workflow:
298298
<table>
299299
<tbody>
300300
<tr>
301-
<td><center>1</center></td>
301+
<td>1</td>
302302
<td>Write your contract
303303
</td>
304304
</tr>
305305
<tr>
306-
<td><center>2</center></td>
306+
<td>2</td>
307307
<td>Install your contract’s source code on Zoe.
308308
</td>
309309
</tr>
310310
<tr>
311-
<td><center>3</center></td>
311+
<td>3</td>
312312
<td>Start a contract instance based on an installed contract.
313313
</td>
314314
</tr>
315315
<tr>
316316
<td colspan="2">At this point, everything is installed and set up and you’ve got a contract instance. The following rows cover what happens while
317317
the Atomic Swap contract instance is active.
318318
</td>
319+
</tr>
319320
<tr>
320-
<tr>
321-
<td><center>1</center></td>
321+
<td>1</td>
322322
<td>A holder of an invitation to this contract instance uses it to get a seat. The assets used in the offer are escrowed with Zoe.
323323
</td>
324324
</tr>
325325
<tr>
326-
<td><center>2</center></td>
326+
<td>2</td>
327327
<td>Likely via means outside of the contract, invitations are distributed to potential users of this contract instance).</td>
328328
</tr>
329329
<tr>
330-
<td><center>3</center></td>
330+
<td>3</td>
331331
<td>Recipients use the InviteIssuer to claim and validate their invitation.
332332
</td>
333333
</tr>
334334
<tr>
335-
<td><center>4</center></td>
335+
<td>4</td>
336336
<td>Invitation holders make their offers.
337337
</td>
338338
</tr>
339339
<tr>
340-
<td><center>5</center></td>
340+
<td>5</td>
341341
<td>The contract code processes the offers, which may request some reallocations as a result.</td>
342342
</tr>
343343
<tr>
344-
<td><center>6</center></td>
344+
<td>6</td>
345345
<td>Zoe reallocates the assets among the offers, preserving offer safety.
346346
</td>
347347
</tr>
348348
<tr>
349-
<td><center>7</center></td>
349+
<td>7</td>
350350
<td>The contract requests Zoe process the satisfied offers, resolving their associated payout promises. Offer holders either get what they paid for, get their escrowed offer amount refunded, or in some cases, get both what they paid for and a refund of any overpayment.
351351
</td>
352352
</tr>

‎main/getting-started/start-a-project.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,23 @@ For starting a local chain with multiple users, making it possible to develop an
2020
[Agoric CLI Guide](https://github.com/Agoric/documentation/blob/cli-multiuser/main/getting-started/agoric-cli-guide.md#starting-multiuser-dapps).
2121

2222
Also, for what needs to be done after you modify a project's code, see
23-
[Development Cycle](https://agoric.com/documentation/getting-started/development-cycle/)
24-
<br><br>
25-
<table border="1">
23+
[Development
24+
Cycle](https://agoric.com/documentation/getting-started/development-cycle/)
25+
26+
<table>
2627
<tbody>
2728
<tr>
2829
<th><b>Step</b></th>
2930
<th><b>Action</b></th>
3031
<th><b>Explanation</b></th>
3132
</th>
3233
<tr>
33-
<td><center>1</center></td>
34+
<td>1</td>
3435
<td>Go to or open a shell and <code>cd &lt;directory-where-you-want-to-install-Dapp-code&gt;</code></td>
3536
<td>When you initialize your project/Dapp in the next step, its initial code is copied into your current directory (permissions allowing).</td>
3637
</tr>
3738
<tr>
38-
<td><center>2</center></td>
39+
<td>2</td>
3940
<td>Run <code>agoric init demo</code>
4041
<td>Initializes a <i>Dapp</i> (<i>Distributed application</i>)
4142
project.
@@ -57,18 +58,18 @@ Also, for what needs to be done after you modify a project's code, see
5758
it to <code>$PATH</code></td>
5859
</tr>
5960
<tr>
60-
<td><center>3</center></td>
61+
<td>3</td>
6162
<td><code>cd demo</code></td>
6263
<td>Move to the directory where your project (the demo) is
6364
located.</td>
6465
</tr>
6566
<tr>
66-
<td><center>4</center></td>
67+
<td>4</td>
6768
<td><code>agoric install</code></td>
6869
<td>Install JavaScript dependencies, which may take a while.</td>
6970
</tr>
7071
<tr>
71-
<td><center>5</center></td>
72+
<td>5</td>
7273
<td><code>agoric start --reset</code><br>
7374
(leave this shell up with the process running)</td>
7475
<td>Start the Agoric VM. <code>--reset</code> discards any prior Agoric
@@ -77,27 +78,27 @@ Also, for what needs to be done after you modify a project's code, see
7778
running commands.</td>
7879
</tr>
7980
<tr>
80-
<td><center>6</center></td>
81+
<td>6</td>
8182
<td>Open another shell, go to your <code>demo</code> directory</td>
8283
<td>For the remainer of this table, we call this the <i>deploy shell</i>.
8384
<br><br>Use the same project directory name and location as you used in Step 2. In
8485
this example, we used <code>demo</code> but you may have used a
8586
different name in Step 2.</td>
8687
</tr>
8788
<tr>
88-
<td><center>7</center></td>
89+
<td>7</td>
8990
<td>In the deploy shell, <code>agoric deploy ./contract/deploy.js ./api/deploy.js</code></td>
9091
<td>Deploy the Dapp on an Agoric VM, install the Dapp's smart
9192
contract and web API, as well as JavaScript code that implements the Agoric APIs for writing and implementing
9293
contracts.</td>
9394
</tr>
9495
<tr>
95-
<td><center>8</center></td>
96+
<td>8</td>
9697
<td>In the deploy shell, <code>(cd ui && yarn start)</code></td>
9798
<td>This starts the demo project's UI development server.</td></td>
9899
</tr>
99100
<tr>
100-
<td><center>9</center></td>
101+
<td>9</td>
101102
<td>Go to a browser and open <code>http://localhost:3000</code> to
102103
see the Dapp. If you used the default values for <code>agoric init</code>
103104
in Step 2, you'll see the Encouragement demo Dapp, described in the next cell.</td>

0 commit comments

Comments
 (0)