Skip to content

Commit 4d975f6

Browse files
committed
docs: setup mkdocs pages and health badges
1 parent ff9f8f2 commit 4d975f6

4 files changed

Lines changed: 45 additions & 0 deletions

File tree

.github/workflows/pages.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy Pages
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- master
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
concurrency:
12+
group: "pages"
13+
cancel-in-progress: false
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: actions/setup-python@v5
20+
with:
21+
python-version: 3.x
22+
- run: pip install mkdocs-material
23+
- run: mkdocs build
24+
- uses: actions/upload-pages-artifact@v3
25+
with:
26+
path: ./site
27+
deploy:
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
31+
runs-on: ubuntu-latest
32+
needs: build
33+
steps:
34+
- name: Deploy to GitHub Pages
35+
id: deployment
36+
uses: actions/deploy-pages@v4

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# CAS Platform
22

3+
[![CI](https://github.com/Coding-Autopilot-System/cas-platform/actions/workflows/ci.yml/badge.svg)](https://github.com/Coding-Autopilot-System/cas-platform/actions/workflows/ci.yml) [![CodeQL](https://github.com/Coding-Autopilot-System/cas-platform/actions/workflows/codeql.yml/badge.svg)](https://github.com/Coding-Autopilot-System/cas-platform/actions/workflows/codeql.yml)
4+
5+
36
Production-oriented Azure infrastructure foundation for the Coding Autopilot
47
System (CAS). It provides environment-isolated Container Apps hosting,
58
workspace-based observability, system-assigned managed identity, budgets, and

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# cas-platform Documentation
2+
3+
Welcome to the documentation for cas-platform.

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
site_name: cas-platform Documentation
2+
theme:
3+
name: material

0 commit comments

Comments
 (0)