Skip to content

Commit 6878e7d

Browse files
imckee-devtylerlv3
authored andcommitted
docs page largely stylistic. Todo, rest of text: Need to add group control and windows sections.
1 parent f3e0300 commit 6878e7d

2 files changed

Lines changed: 103 additions & 20 deletions

File tree

web/src/AppHMI.tsx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,10 +584,11 @@ export default function AppHMI() {
584584
Routines
585585
</button>
586586

587-
<Link to="/docs">
587+
<Link to="/docs"
588+
>
588589
<button
589-
className="hmi-docs-btn"
590-
title="View Docs"
590+
className="hmi-manage-btn"
591+
title="View Docs"
591592
>
592593
Docs
593594
</button>

web/src/components/Docs.tsx

Lines changed: 99 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,108 @@
11
import {Link} from "react-router"
22

3+
4+
//note the classnames in the room of the info are misnamed, but apply nicely to the styling.
35
export default function Docs() {
46

7+
58
return(
69
<>
7-
<Link to="/">
8-
<button
9-
className="home-btn"
10-
title="Home"
11-
>
12-
Back to Home
13-
</button>
14-
</Link>
15-
<h1>Docs Page</h1>
16-
17-
<h2>What is the purpose of each menu?</h2>
18-
19-
<h3>Nav Bar</h3>
20-
21-
<ol>
22-
<li>Sim vs. real</li>
23-
</ol>
10+
<header className="hmi-header">
11+
<div className="hmi-header-inner">
12+
<div className="hmi-brand">
13+
<div className="hmi-logo"></div>
14+
<div className="hmi-brand-text">
15+
<h1>Glazing Control System</h1>
16+
<p>Electrochromic Panel Management</p>
17+
</div>
18+
</div>
19+
<div className="hmi-status">
20+
<div className="hmi-status-item">
21+
<span className="hmi-status-label">System</span>
22+
</div>
23+
24+
<div className="hmi-status-item">
25+
<span className="hmi-status-label">Panels</span>
26+
</div>
27+
28+
<Link to="/">
29+
<button
30+
className="hmi-manage-btn"
31+
title="Home"
32+
>
33+
Back to Home
34+
</button>
35+
</Link>
36+
37+
</div>
38+
</div>
39+
</header>
40+
41+
42+
<main className="hmi-main">
43+
<div className="room-section group-card">
44+
45+
<div className="room-header">
46+
<h1 className="room-title">Docs Page</h1>
47+
48+
</div>
49+
50+
<h2 className="room-header">What is the purpose of each menu?</h2>
51+
52+
53+
54+
</div>
55+
56+
<div className="room-section group-card">
57+
58+
59+
<h2 className="room-header">Nav Bar Info</h2>
60+
<ol>
61+
<li>Sim vs. real</li>
62+
<ul>
63+
<li>We have a simulator option and a real option, the simulator being the default. When in the trailer and connected to Wi-Fi, switch to real.</li>
64+
</ul>
65+
</ol>
66+
67+
<h4 className="room-header">Logs</h4>
68+
<ol>
69+
<li>Audit Log</li>
70+
<ul>
71+
<li>Lists every change so far in the levels of each panel or group.</li>
72+
<li>Sort by date range, panels/group, filter by specific panel ID or title.</li>
73+
<li>Export as CSV: keeps all audits listed, with all filters, in the visible order.</li>
74+
</ul>
75+
76+
<li>Sensor Log - TBA</li>
77+
</ol>
78+
79+
<h4 className="room-header">Manage</h4>
80+
<ol>
81+
<li>Groups</li>
82+
<ul>
83+
<li>...</li>
84+
</ul>
85+
86+
<li>Routines</li>
87+
<ul>
88+
<li>...</li>
89+
</ul>
90+
</ol>
91+
92+
</div>
93+
94+
<div className="room-section group-card">
95+
<h2 className="room-header">Group Control</h2>
96+
97+
</div>
98+
99+
<div className="room-section group-card">
100+
<h2 className="room-header">Windows</h2>
101+
102+
103+
</div>
104+
105+
</main>
24106
</>
25107
)
26108
}

0 commit comments

Comments
 (0)