Skip to content

Docs

This documentation site — how the homelab is used and how it's built · https://docs.fmm.house

What it's for

Docs is the site you're reading right now. It's MkDocs Material rendering the homelab repo's docs/ folder into a clean, searchable website. It's the home for both the friendly "how to use an app" pages and the deeper technical notes, so there's one place to look things up.

Getting in

  • Open: https://docs.fmm.house — on the home Wi-Fi/LAN, or from anywhere with Tailscale connected.
  • Sign in: No login — just open the URL and browse.

How to use it

  • Hit the search box at the top (or press /) and start typing. It searches every page and jumps you straight to the matching section.

Light / dark mode

  • Use the theme toggle in the header to switch between light and dark. It remembers your choice.

Finding your way around

  • Apps — the friendly, user-facing "how to use it" pages (Chat, Games, TRMNL, and more).
  • Technical — the under-the-hood stuff: architecture, runbooks, and configuration notes.
  • Use the left-hand nav to move between sections and the on-page table of contents (right side on desktop) to jump within a page.

It stays in sync with the repo

This site is generated straight from the docs/ folder in the repo. Edit a Markdown file, and the corresponding page updates — the running site live-reloads, so what you read here tracks what's actually committed.

Tips

Tip

Keyboard-friendly: press / to search from anywhere on the site.

  • On mobile the nav collapses into a menu button; on desktop you get the full sidebar plus a per-page table of contents.
  • If a page looks out of date, it's driven by the repo — the fix is to edit the underlying Markdown file, not the site.