How these docs work
This is a Starlight (Astro) documentation site — a traditional, scalable docs UI (sidebar tree, on-page table of contents, offline search, cross-links) for the written documentation, themed to the LumicIQ brand. It complements the standalone decks (pitch, cost, interactive diagrams), which stay as self-contained HTML and are linked from the sidebar.
Authoring a page
Section titled “Authoring a page”- Add a Markdown (
.md) or MDX (.mdx) file undersrc/content/docs/. The folder structure maps to URLs (architecture/overview.md→/architecture/overview/). - Every page needs frontmatter:
---title: My pagedescription: One line for search + social.---
- Add it to the sidebar in
astro.config.mjs(or useautogeneratefor a whole folder). - Commit + push — Cloudflare Pages rebuilds and redeploys.
What you get for free
Section titled “What you get for free”- Sidebar navigation + on-page table of contents + prev/next links.
- Offline search (Pagefind) — fully client-side, so it works behind the Cloudflare Access login with no external crawler. Press / to search.
- Light / dark themes (LumicIQ-warm), responsive, accessible.
- Components via MDX — callouts, cards, tabs, code blocks with syntax highlighting:
Linking the interactive decks
Section titled “Linking the interactive decks”Each deck lives in public/ as <name>/index.html, so it serves at a clean directory URL. Link them
from any page or the sidebar, e.g. the architecture flow or the
cost model. Keep building those as self-contained HTML with the
shared tokens.css — they don’t need the docs framework.
Build & deploy
Section titled “Build & deploy”- Local authoring:
npm installthennpm run dev(hot-reload). To click through the decks, usenpm run preview— the dev server doesn’t serve directory-index files frompublic/. - Production:
npm run build→ static output indist/→ Cloudflare Pages, behind the same Cloudflare Access policy that gates@lumiciq.com.