Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'site/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '22'
cache: 'npm'
cache-dependency-path: site/package-lock.json
- run: npm ci
working-directory: site
- run: npm run build
working-directory: site
- uses: actions/upload-pages-artifact@v3
with:
path: site/dist

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ Gemfile.lock
.rspec_status
/briefer/
/radar/
site/node_modules/
site/dist/
site/.astro/
38 changes: 38 additions & 0 deletions site/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

export default defineConfig({
site: 'https://jayrav13.github.io',
base: '/skywatch',
integrations: [
starlight({
title: 'Skywatch',
description: 'Aviation situational awareness toolkit — real-time weather, flight tracking, and brief composition from public FAA/NWS/ADS-B data.',
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/jayrav13/skywatch' }
],
sidebar: [
{ label: 'Overview', link: '/' },
{ label: 'Getting started', link: '/getting-started/' },
{ label: 'Claude Code agent', link: '/claude-agent/' },
{
label: 'CLI reference',
items: [
{ label: 'brief', link: '/cli/brief/' },
{ label: 'weather', link: '/cli/weather/' },
{ label: 'nimbus', link: '/cli/nimbus/' },
{ label: 'mayday', link: '/cli/mayday/' },
{ label: 'radar', link: '/cli/radar/' },
{ label: 'agent', link: '/cli/agent/' },
],
},
{
label: 'Reference',
items: [
{ label: 'Brief response shape', link: '/reference/brief-shape/' },
],
},
],
}),
],
});
Loading