FRC Team 4973 — Match Results

Match videos, Driver Station log analysis, and performance notes for FRC Team 4973 Gator Gears.

Published at: https://team4973.github.io/results/

---

Repo layout

results/
  docs/               MkDocs source root
    index.md          Home page
    2025 -> ../2025   Symlink (content lives here, not in docs/)
    2026 -> ../2026   Symlink
  2025/<event>/<match>/match.md
  2026/<event>/<match>/match.md
  mkdocs.yml          Site configuration
  requirements-docs.txt
  Dockerfile
  docker-compose.yml
  download_matches.py       Data pipeline scripts
  correlate_dslogs.py
  parse_dslogs.py

README.md (this file) and the Python pipeline scripts are intentionally excluded from the published site.

---

Local preview

Option A — Docker (no Python setup needed)

docker-compose up --build

Site auto-reloads on file changes. Open http://localhost:8000.

To rebuild the image after changing requirements-docs.txt:

docker-compose up --build

Option B — uv (faster iteration)

uv pip install --system -r requirements-docs.txt
mkdocs serve

Or without installing:

uv run --with "mkdocs-material>=9.5,<10" mkdocs serve

Open http://127.0.0.1:8000.

One-shot build check (same as CI)

uv run --with "mkdocs-material>=9.5,<10" mkdocs build --strict

Exits non-zero on any warning or broken nav reference — matches what the PR check runs.

---

Contributing

1. Create a branch, edit match.md files or add new ones.
2. Preview locally with Docker or mkdocs serve.
3. Open a PR — GitHub Actions will run mkdocs build --strict and report pass/fail.
4. Merge to main → Actions builds and deploys automatically. No gh-pages branch involved.

Adding a new match

1. Create 2026/<event_code>/<match_key>/match.md following the structure in existing files.
2. Add the match to the nav: section in mkdocs.yml.
3. Add a row to the event's index.md table.

---

GitHub Pages setup (one-time)

In the repo: Settings → Pages → Build and deployment → Source → GitHub Actions

That's it. The workflow handles the rest on every push to main.

---

Custom domain

When ready to use results.gatorgears4973.org:

1. Create docs/CNAME containing exactly:

   results.gatorgears4973.org
   

2. Update site_url in mkdocs.yml:

   site_url: https://results.gatorgears4973.org/

3. Add a DNS record at your registrar:

   CNAME  results.gatorgears4973.org  ->  team4973.github.io
   

4. GitHub will provision HTTPS automatically (usually within a few minutes).