Skip to content

Commit 88fce94

Browse files
committed
docs: Fix readme and deploy dev docs
1 parent 3f74be5 commit 88fce94

File tree

3 files changed

+38
-8
lines changed

3 files changed

+38
-8
lines changed

.github/workflows/deploy_docs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
name: Deploy Docs
22
on:
33
push:
4-
tags:
5-
- "v*"
4+
branches: [ main ]
5+
paths:
6+
- docs/**
7+
workflow_dispatch:
68

79
jobs:
810
build:
@@ -24,5 +26,5 @@ jobs:
2426
git config --global user.name "Docs Deploy"
2527
git config --global user.email "support@kitchenowl.org"
2628
- name: Build Docs Website
27-
run: mike deploy --push --update-aliases ${{ github.ref_name }} latest
29+
run: mike deploy --push dev
2830
working-directory: docs
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Release Docs
2+
on:
3+
push:
4+
tags:
5+
- "v*"
6+
7+
jobs:
8+
build:
9+
name: Deploy docs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout main
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- uses: actions/setup-python@v4
18+
with:
19+
python-version: 3.12
20+
- name: Install Dependencies
21+
run: pip install -r docs/requirements.txt
22+
- name: Setup Docs Deploy
23+
run: |
24+
git config --global user.name "Docs Deploy"
25+
git config --global user.email "support@kitchenowl.org"
26+
- name: Build Docs Website
27+
run: mike deploy --push --update-aliases ${{ github.ref_name }} latest
28+
working-directory: docs

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align="center">
22
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="./docs/img/icon.png">
4-
<img width="128" src="./docs/img/logo.png" alt="KitchenOwl">
3+
<source media="(prefers-color-scheme: dark)" srcset="./docs/docs/img/icon.png">
4+
<img width="128" src="./docs/docs/img/logo.png" alt="KitchenOwl">
55
</picture>
66
</h1>
77
<p align="center">
@@ -38,13 +38,13 @@
3838

3939
<div align="center">
4040
<a href='https://play.google.com/store/apps/details?id=com.tombursch.kitchenowl'>
41-
<img alt='Get it on Google Play' src='docs/img/badges/playstore.png' height="50" />
41+
<img alt='Get it on Google Play' src='docs/docs/img/badges/playstore.png' height="50" />
4242
</a>
4343
<a href='https://f-droid.org/packages/com.tombursch.kitchenowl/'>
44-
<img alt='Get it on F-Droid' src='docs/img/badges/f-droid.png' height="50"/>
44+
<img alt='Get it on F-Droid' src='docs/docs/img/badges/f-droid.png' height="50"/>
4545
</a>
4646
<a href='https://apps.apple.com/app/kitchenowl/id1557453670'>
47-
<img alt='Get it on the AppStore' src='docs/img/badges/appstore.png' height="50" />
47+
<img alt='Get it on the AppStore' src='docs/docs/img/badges/appstore.png' height="50" />
4848
</a>
4949
</div>
5050

0 commit comments

Comments
 (0)