Skip to content

Commit ed7b0b9

Browse files
MarzoghMarzogh
authored
Merge pull request #10 from Marzogh/othrys/docs-home-refresh
Refresh docs landing page
2 parents d6ef563 + d5bcc2f commit ed7b0b9

3 files changed

Lines changed: 264 additions & 25 deletions

File tree

‎docs/index.md‎

Lines changed: 137 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,146 @@
1-
# OrbitDeck
1+
# OrbitDeck Docs
22

3-
OrbitDeck is a cross-platform dashboard for amateur radio satellites. It provides pass timing, tracking, frequency guidance, APRS operation, AMSAT status comparison, and radio-control surfaces backed by one FastAPI service.
3+
<div class="od-home-intro">
4+
<p class="od-home-kicker">Pass operations documentation</p>
5+
<p class="od-home-lead">
6+
OrbitDeck helps you track passes, tune radios, run APRS, and pick the right screen for the job.
7+
</p>
8+
<p class="od-home-subtle">
9+
Start here to get OrbitDeck running, pick the right screen, and learn the basics before you dig deeper.
10+
</p>
11+
</div>
412

5-
This documentation set covers:
13+
<div class="od-home-actions">
14+
<a class="od-home-button od-home-button--primary" href="guide/quickstart/">Get started with Quick Start</a>
15+
<a class="od-home-button" href="guide/first-hour/">Follow the First Hour walkthrough</a>
16+
<a class="od-home-button" href="guide/common-tasks/">Jump to Common Tasks</a>
17+
</div>
618

7-
- installation and operation on macOS and Raspberry Pi
8-
- implementation details relevant to contributors
19+
## What This Docs Site Covers
920

10-
## Start Here
21+
<div class="od-home-grid od-home-grid--compact">
22+
<section class="od-home-card">
23+
<h3>Platforms</h3>
24+
<p>Use these docs for macOS, Raspberry Pi, and lite mode on smaller hardware.</p>
25+
</section>
26+
<section class="od-home-card">
27+
<h3>Docs site</h3>
28+
<p>The published docs are at <a href="https://chipsncode.com/OrbitDeck/">chipsncode.com/OrbitDeck</a>.</p>
29+
</section>
30+
<section class="od-home-card">
31+
<h3>API docs</h3>
32+
<p>A running OrbitDeck instance shows the live API schema at <code>/docs</code>.</p>
33+
</section>
34+
<section class="od-home-card">
35+
<h3>More help</h3>
36+
<p>Install, troubleshooting, runtime data, and API links are below.</p>
37+
</section>
38+
</div>
1139

12-
- Use [Quick Start](guide/quickstart.md) to get a local instance running quickly.
13-
- Use [First Hour](guide/first-hour.md) for a first-run workflow from startup to pass tracking.
14-
- Use [Common Tasks](guide/common-tasks.md) for the everyday operator actions.
15-
- Use [Core Concepts](guide/concepts.md) when you want the app explained in plain terms.
16-
- Use [Glossary](guide/glossary.md) if a radio or satellite term is unfamiliar.
17-
- Use [Platforms](guide/platforms.md) for the macOS and Raspberry Pi deployment model.
18-
- Use [UI Surfaces](guide/ui-surfaces.md) to understand what `/`, `/lite`, `/lite/settings`, `/aprs`, and `/settings` are each for.
19-
- Use [HTTP API](api/http-api.md) for the current public route map.
40+
## Get Running
2041

21-
## Product Summary
42+
<div class="od-home-grid">
43+
<section class="od-home-card od-home-card--accent">
44+
<h3><a href="guide/quickstart/">Quick Start</a></h3>
45+
<p>The fastest way to get OrbitDeck running.</p>
46+
<ul>
47+
<li>Set up a local run</li>
48+
<li>Open the main routes</li>
49+
<li>Check that the app is working</li>
50+
</ul>
51+
</section>
52+
<section class="od-home-card">
53+
<h3><a href="guide/first-hour/">First Hour</a></h3>
54+
<p>A guided first run from launch to pass tracking.</p>
55+
<ul>
56+
<li>Choose the right screen</li>
57+
<li>Set the basics</li>
58+
<li>Get ready for a pass</li>
59+
</ul>
60+
</section>
61+
<section class="od-home-card">
62+
<h3><a href="INSTALL_AND_RUN/">Install / Build / Run</a></h3>
63+
<p>Use this for full install steps, packaged releases, and build details.</p>
64+
<ul>
65+
<li>macOS DMG notes</li>
66+
<li>Raspberry Pi package flow</li>
67+
<li>Source-run commands</li>
68+
</ul>
69+
</section>
70+
</div>
2271

23-
- `/` opens the focused tracking screen on standard hardware.
24-
- `/lite` opens the phone-friendly and low-power screen.
25-
- `/lite/settings` opens the lite setup and configuration screen.
26-
- `/aprs` opens the APRS console and test surface.
27-
- `/settings` opens the combined settings console on standard hardware and lite settings on Pi Zero-class hardware.
28-
- Pi Zero-class hardware is switched into lite-oriented routing automatically.
72+
## Use OrbitDeck
2973

30-
## Project Links
74+
<div class="od-home-grid">
75+
<section class="od-home-card">
76+
<h3><code>/</code> Main tracking view</h3>
77+
<p>Use the main screen to watch active and upcoming passes and see tuning guidance.</p>
78+
<p><a href="guide/ui-surfaces/">Read about the screens</a></p>
79+
</section>
80+
<section class="od-home-card">
81+
<h3><code>/lite</code> Lite mode</h3>
82+
<p>Use the smaller mobile-friendly screen on Pi Zero-class hardware, phones, or low-power remote setups.</p>
83+
<p><a href="guide/lite-mode/">Read about lite mode</a></p>
84+
</section>
85+
<section class="od-home-card">
86+
<h3><code>/radio</code> Radio validation</h3>
87+
<p>Use the radio screen to test CI-V, manual tuning, or uplink and downlink pairs.</p>
88+
<p><a href="guide/ui-surfaces/">Read about the screens</a></p>
89+
</section>
90+
<section class="od-home-card">
91+
<h3><code>/aprs</code> APRS operations</h3>
92+
<p>Use the APRS screen for setup, status checks, and send tools in terrestrial or satellite mode.</p>
93+
<p><a href="guide/common-tasks/">See common tasks</a></p>
94+
</section>
95+
<section class="od-home-card">
96+
<h3><code>/settings</code> Station setup</h3>
97+
<p>Use settings for location, timezone, pass preferences, radio setup, APRS setup, and debug overrides.</p>
98+
<p><a href="guide/ui-surfaces/">Read about the screens</a></p>
99+
</section>
100+
</div>
31101

32-
- Repository: <https://github.com/Marzogh/OrbitDeck>
33-
- Main install guide: [Install / Build / Run](INSTALL_AND_RUN.md)
102+
## Understand the System
103+
104+
<div class="od-home-grid od-home-grid--compact">
105+
<section class="od-home-card">
106+
<h3><a href="guide/concepts/">Core Concepts</a></h3>
107+
<p>Simple explanations of passes, guidance, APRS, and the main screens.</p>
108+
</section>
109+
<section class="od-home-card">
110+
<h3><a href="guide/platforms/">Platforms</a></h3>
111+
<p>What works on macOS, Raspberry Pi, and Pi Zero-class hardware.</p>
112+
</section>
113+
<section class="od-home-card">
114+
<h3><a href="guide/frequency-guidance/">Frequency Guidance</a></h3>
115+
<p>How OrbitDeck chooses tune-now and tune-next recommendations.</p>
116+
</section>
117+
<section class="od-home-card">
118+
<h3><a href="guide/glossary/">Glossary</a></h3>
119+
<p>Quick definitions for radio and satellite terms.</p>
120+
</section>
121+
</div>
122+
123+
## Reference and Troubleshooting
124+
125+
<div class="od-home-grid od-home-grid--compact">
126+
<section class="od-home-card">
127+
<h3><a href="api/http-api/">HTTP API</a></h3>
128+
<p>Read the current route map and request shapes used by the UI and API tools.</p>
129+
</section>
130+
<section class="od-home-card">
131+
<h3><a href="api/settings/">Settings Reference</a></h3>
132+
<p>See the settings model for location, pass filters, radio, APRS, and overrides.</p>
133+
</section>
134+
<section class="od-home-card">
135+
<h3><a href="operations/troubleshooting/">Troubleshooting</a></h3>
136+
<p>Use this when launch, APRS, radio control, or route behavior is not doing what you expect.</p>
137+
</section>
138+
<section class="od-home-card">
139+
<h3><a href="operations/runtime-data/">Runtime Data</a></h3>
140+
<p>Find state files, caches, snapshots, and writable locations.</p>
141+
</section>
142+
<section class="od-home-card">
143+
<h3><a href="CONTRIBUTING/">Docs Contributing Guide</a></h3>
144+
<p>Use this if you want to work on the docs.</p>
145+
</section>
146+
</div>

‎docs/stylesheets/docs-home.css‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
.od-home-intro {
2+
margin: 0 0 1.5rem;
3+
}
4+
5+
.od-home-kicker {
6+
margin: 0 0 0.45rem;
7+
color: var(--md-primary-fg-color);
8+
font-size: 0.78rem;
9+
font-weight: 700;
10+
letter-spacing: 0.12em;
11+
text-transform: uppercase;
12+
}
13+
14+
.od-home-lead {
15+
margin: 0;
16+
max-width: 46rem;
17+
font-size: 1.15rem;
18+
line-height: 1.6;
19+
font-weight: 500;
20+
}
21+
22+
.od-home-subtle {
23+
margin: 0.85rem 0 0;
24+
max-width: 44rem;
25+
color: var(--md-default-fg-color--light);
26+
}
27+
28+
.od-home-actions {
29+
display: flex;
30+
flex-wrap: wrap;
31+
gap: 0.75rem;
32+
margin: 1.4rem 0 2.2rem;
33+
}
34+
35+
.od-home-button {
36+
display: inline-flex;
37+
align-items: center;
38+
justify-content: center;
39+
min-height: 2.8rem;
40+
padding: 0.7rem 1rem;
41+
border: 1px solid color-mix(in srgb, var(--md-default-fg-color) 12%, transparent);
42+
border-radius: 0.9rem;
43+
background: color-mix(in srgb, var(--md-code-bg-color) 60%, transparent);
44+
color: var(--md-default-fg-color);
45+
font-weight: 600;
46+
text-decoration: none;
47+
transition: border-color 120ms ease, transform 120ms ease, background 120ms ease;
48+
}
49+
50+
.od-home-button:hover {
51+
border-color: color-mix(in srgb, var(--md-primary-fg-color) 35%, transparent);
52+
background: color-mix(in srgb, var(--md-primary-fg-color) 8%, var(--md-code-bg-color));
53+
transform: translateY(-1px);
54+
}
55+
56+
.od-home-button--primary {
57+
border-color: color-mix(in srgb, var(--md-primary-fg-color) 45%, transparent);
58+
background: color-mix(in srgb, var(--md-primary-fg-color) 12%, var(--md-code-bg-color));
59+
}
60+
61+
.od-home-grid {
62+
display: grid;
63+
grid-template-columns: repeat(auto-fit, minmax(15rem, 1fr));
64+
gap: 1rem;
65+
margin: 1rem 0 2rem;
66+
}
67+
68+
.od-home-grid--compact {
69+
grid-template-columns: repeat(auto-fit, minmax(13rem, 1fr));
70+
}
71+
72+
.od-home-card {
73+
height: 100%;
74+
padding: 1rem 1rem 1.05rem;
75+
border: 1px solid color-mix(in srgb, var(--md-default-fg-color) 10%, transparent);
76+
border-radius: 1rem;
77+
background: color-mix(in srgb, var(--md-code-bg-color) 58%, transparent);
78+
box-shadow: 0 1px 0 color-mix(in srgb, var(--md-default-fg-color) 4%, transparent);
79+
}
80+
81+
.od-home-card--accent {
82+
border-color: color-mix(in srgb, var(--md-primary-fg-color) 24%, transparent);
83+
background: color-mix(in srgb, var(--md-primary-fg-color) 7%, var(--md-code-bg-color));
84+
}
85+
86+
.od-home-card h3 {
87+
margin-top: 0;
88+
margin-bottom: 0.55rem;
89+
font-size: 1rem;
90+
}
91+
92+
.od-home-card p {
93+
margin: 0 0 0.75rem;
94+
}
95+
96+
.od-home-card p:last-child,
97+
.od-home-card ul:last-child {
98+
margin-bottom: 0;
99+
}
100+
101+
.od-home-card ul {
102+
margin: 0;
103+
padding-left: 1.05rem;
104+
}
105+
106+
.od-home-card li + li {
107+
margin-top: 0.28rem;
108+
}
109+
110+
@media (max-width: 44.9375em) {
111+
.od-home-lead {
112+
font-size: 1.02rem;
113+
}
114+
115+
.od-home-actions {
116+
flex-direction: column;
117+
}
118+
119+
.od-home-button {
120+
width: 100%;
121+
justify-content: flex-start;
122+
}
123+
}

‎mkdocs.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: OrbitDeck
22
site_description: Cross-platform amateur satellite operations dashboard documentation
3-
site_url: https://marzogh.github.io/OrbitDeck/
3+
site_url: https://chipsncode.com/OrbitDeck/
44
repo_url: https://github.com/Marzogh/OrbitDeck
55
repo_name: Marzogh/OrbitDeck
66
edit_uri: edit/main/docs/
@@ -57,6 +57,9 @@ markdown_extensions:
5757
- fenced_code
5858
- attr_list
5959

60+
extra_css:
61+
- stylesheets/docs-home.css
62+
6063
extra:
6164
social:
6265
- icon: fontawesome/brands/github

0 commit comments

Comments
 (0)