Skip to content
This repository was archived by the owner on Dec 20, 2023. It is now read-only.

Commit a8128ec

Browse files
committed
Update to Material icon support in docs
1 parent 9333e66 commit a8128ec

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

doc/STYLE_GUIDE.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,17 +185,20 @@ understanding of Weave by highlighting common elements and are not official Weav
185185
icons.
186186

187187
> You are not required to use these icons, but we may ask to insert them during the review
188-
process, in order to tie content together across the documentation site.
188+
process, in order to visually tie concepts together across the documentation site.
189189

190190
Example: https://openweave.io/guides/tools#weave-heartbeat
191191

192192
To use these icons in your content, so that they render on the openweave.io documentation site,
193-
surround one of the supported keywords with semicolons. The word can be upper or lowercase.
193+
surround one of the supported keywords with an underscore+asterisk combo.
194194

195195
For example:
196196

197-
* ;Echo;
198-
* ;heartbeat;
197+
<div>_*Echo*_</div>
198+
<div>_*heartbeat*_</div>
199+
200+
The keyword can be upper or lowercase. Use of this format with unsupported keywords merely
201+
renders the text in italics.
199202

200203
See the **OpenWeave Tools** page for an example of this:
201204

doc/guides/tools/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Tool | Description | [Standalone build](https://openweave.io/guides/build#standa
1515
`weave` | Generate and manage Weave certificates | `/src/tools/weave`
1616
`weave-device-descriptor` | Encode and decode Weave device descriptor strings for pairing QR codes | `/src/test-apps`
1717
[`weave-device-mgr`](/guides/tools/device-manager) | Manage the device pairing process | `/src/device-manager/python`
18-
`weave-heartbeat` | Send and receive <a href="https://openweave.io/guides/weave-primer/profiles#heartbeat">;Heartbeat;</a> profile messages | `/src/test-apps`
18+
`weave-heartbeat` | Send and receive <a href="https://openweave.io/guides/weave-primer/profiles#heartbeat">_*Heartbeat*_</a> profile messages | `/src/test-apps`
1919
`weave-key-export` | Send key export requests | `/src/test-apps`
20-
`weave-ping`| Send and receive <a href="https://openweave.io/guides/weave-primer/profiles#echo">;Echo;</a> profile messages | `/src/test-apps`
20+
`weave-ping`| Send and receive <a href="https://openweave.io/guides/weave-primer/profiles#echo">_*Echo*_</a> profile messages | `/src/test-apps`
2121

2222
To build the target:
2323

@@ -167,7 +167,7 @@ Primary WiFi MAC: 5C:F3:70:80:0E:77
167167
## weave-heartbeat
168168

169169
Use `weave-heartbeat` to send and receive
170-
<a href="https://openweave.io/guides/weave-primer/profiles#heartbeat">;Heartbeat;</a> profile messages between
170+
<a href="https://openweave.io/guides/weave-primer/profiles#heartbeat">_*Heartbeat*_</a> profile messages between
171171
two Weave nodes. Heartbeat provides a means to indicate liveness of one node to
172172
the other nodes in the network, or to check if a node remains connected to the
173173
fabric.
@@ -260,7 +260,7 @@ $ ./mock-device -a fd00:0:1:1::1
260260
## weave-ping
261261

262262
Use `weave-ping` to send and receive
263-
<a href="https://openweave.io/guides/weave-primer/profiles#echo">;Echo;</a> profile messages
263+
<a href="https://openweave.io/guides/weave-primer/profiles#echo">_*Echo*_</a> profile messages
264264
between two Weave nodes. An Echo payload consists of arbitrary data supplied by
265265
the requesting node and is expected to be echoed back verbatim in the response.
266266
Echo provides a means to test network connectivity and latency.

0 commit comments

Comments
 (0)