Skip to content

Add GitHub Pages documentation site - #15

Merged
rorpage merged 3 commits into
mainfrom
copilot/publish-documentation-website
Jul 3, 2026
Merged

Add GitHub Pages documentation site#15
rorpage merged 3 commits into
mainfrom
copilot/publish-documentation-website

Conversation

Copilot AI commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Publishes a static documentation site for Gee Bee via GitHub Pages.

docs/index.html

Single-page responsive site covering:

  • Feature overview (cards)
  • Quick start (clone → configure → run/build)
  • Docker run & Compose examples
  • Full configuration reference table (config key, env var, default, description)
  • Notification integration details for Discord, Slack, and custom webhook (including JSON payload shape)
  • Taskfile command reference

.github/workflows/pages.yml

Deploys docs/ to GitHub Pages on push to main (path-filtered to docs/**) and via workflow_dispatch. Uses the standard configure-pagesupload-pages-artifactdeploy-pages action chain.

To activate: set Pages source to GitHub Actions under repo Settings → Pages.

Documentation site preview

Copilot AI linked an issue Apr 14, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add documentation website using GitHub Pages Add GitHub Pages documentation site Apr 14, 2026
Copilot AI requested a review from rorpage April 14, 2026 14:03
Copilot AI and others added 3 commits July 3, 2026 13:16
Removes references to Docker, Docker Compose, and fetchInterval (all
gone in the July 3 refactor). Adds installation from pre-built
release binaries, systemd timer / cron scheduling, the stateFilePath
config field, and a versioning section describing the CalVer release
pipeline.
@rorpage
rorpage force-pushed the copilot/publish-documentation-website branch from 8af5563 to 06dab89 Compare July 3, 2026 13:17

rorpage commented Jul 3, 2026

Copy link
Copy Markdown
Owner

Rebased onto current main and updated docs/index.html to match the July 3 one-shot/cron-systemd refactor:

  • Removed the Docker/Docker Compose section and "Docker Ready" feature card
  • Removed fetchInterval (no more polling loop)
  • Added an Installation section (pre-built release binaries + build from source)
  • Added a Scheduling section (systemd timer / cron, replacing the old Docker instructions)
  • Added the stateFilePath/STATE_FILE config field and a note that CONFIG_FILE controls config file lookup
  • Added a note that the custom webhook only receives the first aircraft per batch
  • Added a Versioning section describing the CalVer release pipeline

.github/workflows/pages.yml was left as-is — still correct. Ready for another look.


Generated by Claude Code

@rorpage
rorpage marked this pull request as ready for review July 3, 2026 13:22
@rorpage
rorpage merged commit 2e067e0 into main Jul 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation website

3 participants