Skip to content

docs: publish a developer guide on GitHub Pages and optimize for search #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pierrejochem merged 1 commit into from
Oct 4, 2026
Merged

docs: publish a developer guide on GitHub Pages and optimize for search #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
A standalone, independently buildable reference for writing an **external module**
for the [Speculum smart-mirror dashboard](https://github.com/pierrejochem/SpeculumSmartMirror).

📖 **[Developer guide](https://pierrejochem.github.io/SpeculumExampleModule/)** — quickstart, module anatomy, and declaring settings.

It builds to a thin JAR that the Speculum app discovers at runtime — no app
rebuild, no source checkout of the mirror required. It demonstrates the full
module API: config reading, the `start()` / `refresh()` / `stop()` lifecycle,
Expand All @@ -25,7 +27,8 @@ last notification it received.
`URLClassLoader`, and finds factories via the JDK `ServiceLoader`.
- The factory declares its config options through `settingsSchema()`, so the
Speculum admin console renders real controls for them. See
[Module settings](#module-settings).
[Module settings](#module-settings), or the guide's
[Settings Schema](https://pierrejochem.github.io/SpeculumExampleModule/settings-schema.html) page.

## Requirements

Expand Down Expand Up @@ -131,6 +134,18 @@ The method has a default empty implementation, so a module that declares nothing
still works and simply keeps the raw key/value rows. Any key saved in a config
but absent from the schema also falls back to a raw row.

## Documentation

| Page | Covers |
| --- | --- |
| [Developer guide](https://pierrejochem.github.io/SpeculumExampleModule/) | Overview and how the host discovers a plugin. |
| [Quickstart](https://pierrejochem.github.io/SpeculumExampleModule/quickstart.html) | Run the released JAR, or build and deploy from source. |
| [Module Anatomy](https://pierrejochem.github.io/SpeculumExampleModule/module-anatomy.html) | Every file in the project and what the host does with it. |
| [Settings Schema](https://pierrejochem.github.io/SpeculumExampleModule/settings-schema.html) | Declaring options the admin console renders as typed controls. |
| [mirror-api Reference](https://pierrejochem.github.io/SpeculumSmartMirror/api-reference.html) | The published API this module compiles against. |

The guide is published from [`docs/`](docs/) via GitHub Pages.

## Bumping the API version

`mirror-api` is released on every `v*` tag of the Speculum project; the version
Expand Down
Empty file added docs/.nojekyll
View file
Open in desktop
Empty file.
254 changes: 254 additions & 0 deletions docs/assets/css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
/* Speculum docs — "magic mirror" aesthetic: pure black, bright white, three brightness tiers */
:root {
--bg: #000000;
--surface: #0a0a0b;
--surface-2: #111113;
--border: #1f1f23;
--border-2: #2a2a30;
--bright: #ffffff; /* MirrorColors.Bright */
--normal: #b9b9bd; /* slightly lifted from #999 for body legibility */
--dimmed: #6c6c74; /* MirrorColors.Dimmed */
--accent: #7c5cff; /* Kotlin-inspired violet */
--accent-2: #45c4ff;
--glow: rgba(124, 92, 255, 0.35);
--mono: "SFMono-Regular", ui-monospace, "JetBrains Mono", "Cascadia Code", Menlo, Consolas, monospace;
--sans: "Roboto", -apple-system, BlinkMacSystemFont, "Segoe UI", system-ui, sans-serif;
--maxw: 1080px;
}

* { box-sizing: border-box; }

html { scroll-behavior: smooth; -webkit-text-size-adjust: 100%; }

body {
margin: 0;
background: var(--bg);
color: var(--normal);
font-family: var(--sans);
font-size: 17px;
line-height: 1.7;
letter-spacing: 0.1px;
-webkit-font-smoothing: antialiased;
text-rendering: optimizeLegibility;
}

/* faint radial vignette — the "reflection" */
body::before {
content: "";
position: fixed;
inset: 0;
background:
radial-gradient(900px 500px at 50% -10%, rgba(124,92,255,0.10), transparent 70%),
radial-gradient(700px 500px at 100% 0%, rgba(69,196,255,0.06), transparent 60%);
pointer-events: none;
z-index: 0;
}

a { color: var(--accent-2); text-decoration: none; }
a:hover { color: var(--bright); text-decoration: underline; text-underline-offset: 3px; }

h1, h2, h3, h4 { color: var(--bright); line-height: 1.2; font-weight: 700; letter-spacing: -0.02em; }
h1 { font-size: clamp(2rem, 5vw, 3.2rem); margin: 0 0 0.4em; }
h2 { font-size: 1.7rem; margin: 2.4em 0 0.6em; padding-top: 0.4em; }
h3 { font-size: 1.2rem; margin: 1.8em 0 0.4em; color: var(--bright); }
h2 .anchor, h3 .anchor { color: var(--dimmed); font-weight: 400; margin-left: .4rem; opacity: 0; transition: opacity .15s; }
h2:hover .anchor, h3:hover .anchor { opacity: 1; }

p { margin: 0 0 1.1em; }

code {
font-family: var(--mono);
font-size: 0.86em;
background: var(--surface-2);
border: 1px solid var(--border);
border-radius: 5px;
padding: 0.12em 0.42em;
color: #e6e1ff;
}

pre {
background: var(--surface);
border: 1px solid var(--border);
border-radius: 12px;
padding: 1.1rem 1.25rem;
overflow-x: auto;
margin: 0 0 1.4em;
position: relative;
box-shadow: inset 0 1px 0 rgba(255,255,255,0.02);
}
pre code { background: none; border: 0; padding: 0; color: #d7d7df; font-size: 0.84rem; line-height: 1.6; }

/* ---------- top nav ---------- */
header.nav {
position: sticky; top: 0; z-index: 100;
background: rgba(0,0,0,0.72);
backdrop-filter: saturate(160%) blur(14px);
-webkit-backdrop-filter: saturate(160%) blur(14px);
border-bottom: 1px solid var(--border);
}
.nav-inner {
max-width: var(--maxw); margin: 0 auto;
display: flex; align-items: center; gap: 1.5rem;
padding: 0.7rem 1.4rem;
}
.brand { display: flex; align-items: center; gap: 0.6rem; font-weight: 700; color: var(--bright); letter-spacing: -0.01em; }
.brand img { height: 30px; width: auto; display: block; }
.brand:hover { text-decoration: none; }
.nav-links { display: flex; gap: 0.3rem; flex-wrap: wrap; margin-left: auto; align-items: center; }
.nav-links a {
color: var(--normal); font-size: 0.93rem; font-weight: 500;
padding: 0.4rem 0.7rem; border-radius: 8px; white-space: nowrap;
}
.nav-links a:hover { color: var(--bright); background: var(--surface-2); text-decoration: none; }
.nav-links a.active { color: var(--bright); background: var(--surface-2); box-shadow: inset 0 0 0 1px var(--border-2); }
.nav-links a.gh { color: var(--dimmed); }

/* dropdown groups (<details>/<summary>) */
.nav-group { position: relative; }
.nav-group > summary {
list-style: none; cursor: pointer;
color: var(--normal); font-size: 0.93rem; font-weight: 500;
padding: 0.4rem 0.7rem; border-radius: 8px; white-space: nowrap;
display: inline-flex; align-items: center; gap: 0.3rem;
}
.nav-group > summary::-webkit-details-marker { display: none; }
.nav-group > summary::after { content: "▾"; font-size: 0.7em; opacity: 0.7; }
.nav-group > summary:hover { color: var(--bright); background: var(--surface-2); }
.nav-group.active > summary { color: var(--bright); background: var(--surface-2); box-shadow: inset 0 0 0 1px var(--border-2); }
.nav-menu {
display: none; position: absolute; top: 100%; right: 0; margin-top: 0.4rem;
flex-direction: column; gap: 0.1rem; min-width: 12rem;
background: rgba(0,0,0,0.96); border: 1px solid var(--border-2); border-radius: 10px;
padding: 0.35rem; box-shadow: 0 12px 30px rgba(0,0,0,0.45);
}
.nav-group:hover .nav-menu, .nav-group[open] .nav-menu { display: flex; }
.nav-menu a {
color: var(--normal); font-size: 0.93rem; font-weight: 500;
padding: 0.45rem 0.7rem; border-radius: 7px; white-space: nowrap;
}
.nav-menu a:hover { color: var(--bright); background: var(--surface-2); text-decoration: none; }
.nav-menu a.active { color: var(--bright); background: var(--surface-2); box-shadow: inset 0 0 0 1px var(--border-2); }

.menu-toggle { display: none; background: none; border: 1px solid var(--border-2); color: var(--bright);
border-radius: 8px; padding: 0.35rem 0.6rem; font-size: 1.1rem; cursor: pointer; }

/* ---------- layout ---------- */
main { position: relative; z-index: 1; max-width: var(--maxw); margin: 0 auto; padding: 2.6rem 1.4rem 5rem; }
.lead { font-size: 1.18rem; color: var(--normal); max-width: 60ch; }

/* ---------- hero ---------- */
.hero { text-align: center; padding: 3.5rem 0 2rem; }
.hero img.logo { width: min(440px, 80%); height: auto; filter: drop-shadow(0 0 40px var(--glow)); margin-bottom: 1.2rem; }
.hero .lead { margin: 0 auto 1.8rem; }
.eyebrow { text-transform: uppercase; letter-spacing: 0.28em; font-size: 0.72rem; color: var(--accent-2); font-weight: 600; margin-bottom: 1rem; }

/* ---------- buttons ---------- */
.btn-row { display: flex; gap: 0.8rem; justify-content: center; flex-wrap: wrap; margin-top: 1.4rem; }
.btn {
display: inline-flex; align-items: center; gap: 0.5rem;
padding: 0.7rem 1.3rem; border-radius: 10px; font-weight: 600; font-size: 0.96rem;
border: 1px solid var(--border-2); color: var(--bright); background: var(--surface-2);
transition: transform .12s ease, box-shadow .2s ease, border-color .2s;
}
.btn:hover { text-decoration: none; transform: translateY(-2px); border-color: var(--accent); }
.btn.primary { background: linear-gradient(180deg, #8e72ff, #6d4cff); border-color: transparent; box-shadow: 0 8px 30px var(--glow); }
.btn.primary:hover { box-shadow: 0 10px 40px var(--glow); }

/* ---------- cards ---------- */
.grid { display: grid; gap: 1rem; margin: 1.6rem 0; }
.grid.cols-2 { grid-template-columns: repeat(2, 1fr); }
.grid.cols-3 { grid-template-columns: repeat(3, 1fr); }
.card {
background: var(--surface); border: 1px solid var(--border); border-radius: 14px;
padding: 1.25rem 1.3rem; transition: border-color .2s, transform .15s, background .2s;
}
.card:hover { border-color: var(--border-2); transform: translateY(-2px); background: var(--surface-2); }
.card h3 { margin: 0 0 0.3rem; font-size: 1.05rem; }
.card p { margin: 0; color: var(--normal); font-size: 0.95rem; }
.card .ic { font-size: 1.4rem; display: block; margin-bottom: 0.5rem; }
.card a.more { display: inline-block; margin-top: 0.7rem; font-size: 0.9rem; font-weight: 600; }

/* ---------- tables ---------- */
.table-wrap { overflow-x: auto; margin: 0 0 1.4em; border: 1px solid var(--border); border-radius: 12px; }
table { border-collapse: collapse; width: 100%; font-size: 0.92rem; }
th, td { text-align: left; padding: 0.7rem 0.95rem; border-bottom: 1px solid var(--border); vertical-align: top; }
thead th { background: var(--surface-2); color: var(--bright); font-weight: 600; white-space: nowrap; }
tbody tr:last-child td { border-bottom: 0; }
tbody tr:hover { background: var(--surface); }
td code, th code { font-size: 0.85em; }

/* ---------- callouts ---------- */
.note, .warn {
border-radius: 12px; padding: 0.9rem 1.1rem; margin: 0 0 1.4em;
border: 1px solid var(--border-2); background: var(--surface);
font-size: 0.95rem;
}
.note { border-left: 3px solid var(--accent-2); }
.warn { border-left: 3px solid #ffb454; }
.note strong, .warn strong { color: var(--bright); }

/* ---------- misc ---------- */
hr { border: 0; border-top: 1px solid var(--border); margin: 3rem 0; }
ul, ol { padding-left: 1.3rem; }
li { margin: 0.3em 0; }
li::marker { color: var(--dimmed); }
.kicker { color: var(--dimmed); font-size: 0.85rem; text-transform: uppercase; letter-spacing: 0.15em; }
.center { text-align: center; }
.muted { color: var(--dimmed); }
.shot { width: 100%; border-radius: 14px; border: 1px solid var(--border); display: block; }
figure { margin: 0 0 1.4em; }
figcaption { color: var(--dimmed); font-size: 0.85rem; text-align: center; margin-top: 0.5rem; }

.pill { display: inline-block; font-size: 0.72rem; font-weight: 600; letter-spacing: 0.05em;
padding: 0.2rem 0.55rem; border-radius: 999px; border: 1px solid var(--border-2); color: var(--normal); }
.pill.ok { color: #7ee787; border-color: #1f5128; }
.pill.auth { color: #ffb454; border-color: #5a3f1a; }

.toc { background: var(--surface); border: 1px solid var(--border); border-radius: 12px; padding: 1rem 1.3rem; margin: 0 0 2rem; }
.toc strong { color: var(--bright); font-size: 0.8rem; text-transform: uppercase; letter-spacing: 0.12em; }
.toc ul { columns: 2; margin: 0.5rem 0 0; }
.toc a { color: var(--normal); }

/* ---------- footer ---------- */
footer.site {
position: relative; z-index: 1; border-top: 1px solid var(--border);
padding: 2.5rem 1.4rem; margin-top: 2rem;
}
.footer-inner { max-width: var(--maxw); margin: 0 auto; display: flex; flex-wrap: wrap; gap: 1rem; align-items: center; justify-content: space-between; color: var(--dimmed); font-size: 0.9rem; }
.footer-inner a { color: var(--normal); }
.footer-links { display: flex; gap: 1.2rem; flex-wrap: wrap; }

/* ---------- responsive ---------- */
@media (max-width: 820px) {
.grid.cols-2, .grid.cols-3 { grid-template-columns: 1fr; }
.toc ul { columns: 1; }
.menu-toggle { display: inline-block; margin-left: auto; }
.nav-links {
display: none; position: absolute; top: 100%; left: 0; right: 0;
flex-direction: column; align-items: stretch; gap: 0.1rem;
background: rgba(0,0,0,0.96); border-bottom: 1px solid var(--border);
padding: 0.6rem 1rem 1rem; margin: 0;
}
.nav-links.open { display: flex; }
.nav-links a { padding: 0.7rem 0.8rem; }
.nav-group { width: 100%; }
.nav-group > summary { padding: 0.7rem 0.8rem; }
.nav-menu {
position: static; min-width: 0; margin: 0; padding: 0 0 0 0.9rem;
border: 0; box-shadow: none; background: none;
}
.nav-group:hover .nav-menu { display: none; }
.nav-group[open] .nav-menu { display: flex; }
}
/* Visually hidden, but still read by screen readers and search engines. */
.sr-only {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border: 0;
}
20 changes: 20 additions & 0 deletions docs/assets/img/icon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/social.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading