Skip to content

Commit 10e8167

Browse files
authored
docs: Starlight documentation site (#24)
* docs: replace MkDocs with Starlight documentation site - Astro/Starlight for modern static site generation - Complete documentation covering: - Getting started (intro, install, config, first deployment) - Stack details (Dockerfile, Nginx, PHP, Supervisor) - Architecture (Coolify, Postgres+Dragonfly, Horizon, Reverb) - All artisan commands - Dashboard and API reference - Advanced topics (customization, multi-app, CI/CD) - GitHub Actions workflow for Pages deployment - Mermaid diagrams for architecture visualization Closes #21 Stu Mason + AI <me@stumason.dev> * docs: add simple index page Stu Mason + AI <me@stumason.dev> * docs: add mermaid support and improve stack overview - Add starlight-client-mermaid plugin for diagram rendering - Rewrite stack overview to clearly show Coolify resources - Show Project > Environment > App/DB/Cache hierarchy - Clarify Dockerfile + private key deployment model Stu Mason + AI <me@stumason.dev> * docs: replace boilerplate README with project docs Stu Mason + AI <me@stumason.dev>
1 parent da60f9e commit 10e8167

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+9791
-603
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
- '.github/workflows/deploy-docs.yml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 20
31+
cache: npm
32+
cache-dependency-path: docs/package-lock.json
33+
34+
- name: Setup Pages
35+
id: pages
36+
uses: actions/configure-pages@v4
37+
38+
- name: Install dependencies
39+
working-directory: docs
40+
run: npm ci
41+
42+
- name: Build
43+
working-directory: docs
44+
run: npm run build
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/dist
50+
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
needs: build
56+
runs-on: ubuntu-latest
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

docs/DASHBOARD_ROADMAP.md

Lines changed: 0 additions & 178 deletions
This file was deleted.

0 commit comments

Comments
 (0)