Skip to content

Commit ee4c4ad

Browse files
committed
finish quick-start docs and stub out new-model doc
1 parent ea0f9bb commit ee4c4ad

8 files changed

+227
-20
lines changed

pkg/device/docs/device-ui.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h4>DEVICE TO UI</h4>
1+
<h2>DEVICE TO UI</h2>
22

33
<p>The device can route packets up the network tree using Packet.RouteUp().
44
Packets are routed to uplinks and sessions.</p>

pkg/device/docs/images/under-construction.svg

+170
Loading

pkg/device/docs/new-model.html

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<h2>NEW MODEL</h2>
2+
3+
<img class="w-32" src="/docs/images/under-construction.svg">
4+
5+
<p>This page is under construction. If you're looking to create new device
6+
model, this is where you would look.</p>
7+
8+
<p>In the meantime, find the <button>Show Code</button> button one of the demo
9+
devices to see how it's constructed. The devices are written in Go and
10+
HTMX.</p>

pkg/device/docs/quick-start-1.html

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@
33
<div class="flex flex-row mx-2.5 my-8 justify-evenly items-center relative"
44
hx-target="#steps"
55
hx-swap="outerHTML">
6-
<div class="bar absolute h-3 w-80 z-0 bg-text"></div>
6+
<div class="bar absolute h-3 w-52 z-0 bg-text"></div>
77
<button class="round-button-selected relative z-10">Install Hub</button>
88
<button class="round-button relative z-10" hx-get="/docs/quick-start-2.html">Create Device</button>
9-
<button class="round-button relative z-10" hx-get="/docs/quick-start-3.html">Deploy Device</button>
109
</div>
1110

11+
<p>The first step is to install your hub.</p>
12+
1213
<p>Your hub is private which means you have to install and run it somewhere you
1314
control, either on a local resource such as laptop, PC, or Raspberry Pi, or on
1415
a remote resource in the "cloud".</p>
1516

1617
<p class="mb-8">There are multiple ways to <a href="/doc/install">install a hub</a>.
17-
Here are a few:</p>
18+
Here are a few examples:</p>
1819

1920
<div id="tabs"
2021
hx-get="/docs/quick-start-1-docker.html"
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<div id="tabs">
2+
3+
<div class="flex flex-row mb-8 tab-list justify-evenly"
4+
hx-target="#tabs"
5+
hx-swap="outerHTML">
6+
<button class="tab" hx-get="/docs/quick-start-2-relays.html">Relays (Arduino rp2040)</button>
7+
<button class="tab-selected cursor-default">Camera (Raspberry Pi)</button>
8+
</div>
9+
10+
<video controls playsinline muted height="280">
11+
<source src="https://media.merliot.io/videos/camera-install.mp4" type="video/mp4">
12+
Your browser does not support the MP4 video format.
13+
</video>
14+
15+
</div>
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<div id="tabs">
2+
3+
<div class="flex flex-row mb-8 tab-list justify-evenly"
4+
hx-target="#tabs"
5+
hx-swap="outerHTML">
6+
<button class="tab-selected cursor-default">Relays (Arduino rp2040)</button>
7+
<button class="tab" hx-get="/docs/quick-start-2-camera.html">Camera (Raspberry Pi)</button>
8+
</div>
9+
10+
<video controls playsinline muted height="280">
11+
<source src="https://media.merliot.io/videos/relays-install.mp4" type="video/mp4">
12+
Your browser does not support the MP4 video format.
13+
</video>
14+
15+
</div>

pkg/device/docs/quick-start-2.html

+12-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@
33
<div class="flex flex-row mx-2.5 my-8 justify-evenly items-center relative"
44
hx-target="#steps"
55
hx-swap="outerHTML">
6-
<div class="bar absolute h-3 w-80 z-0 bg-text"></div>
6+
<div class="bar absolute h-3 w-52 z-0 bg-text"></div>
77
<button class="round-button relative z-10" hx-get="/docs/quick-start-1.html">Install Hub</button>
88
<button class="round-button-selected relative z-10">Create Device</button>
9-
<button class="round-button relative z-10" hx-get="/docs/quick-start-3.html">Deploy Device</button>
109
</div>
1110

12-
<p>Create device...adfvasdf sadf asdf asdf asdf asdf asdf asdf sa dfsa fsa fd saf safd asfd asdf sadf </p>
11+
<p>Once the hub is installed, the next step is to create and deploy
12+
devices on the hub.</p>
13+
14+
<p>Here are some example videos showing device installs:</p>
15+
16+
<div id="tabs"
17+
hx-get="/docs/quick-start-2-relays.html"
18+
hx-trigger="load"
19+
hx-target="#tabs"
20+
hx-swap="outerHTML">
21+
</div>
1322
</div>

pkg/device/docs/quick-start-3.html

-13
This file was deleted.

0 commit comments

Comments
 (0)