Skip to content

Commit 7413e80

Browse files
committed
docs: documentation and readme improvments
1 parent a0f5229 commit 7413e80

10 files changed

Lines changed: 489 additions & 455 deletions

File tree

README.md

Lines changed: 285 additions & 190 deletions
Large diffs are not rendered by default.

Taskfile.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ tasks:
113113
docs:serve:
114114
desc: Serve documentation locally with live reload
115115
cmds:
116-
- poetry run mkdocs serve --dev-addr=0.0.0.0:8000
116+
- poetry run mkdocs serve --dev-addr=0.0.0.0:{{.PORT}}
117+
vars:
118+
PORT: "{{ .PORT | default 8000 }}"
117119

118120
docs:validate:
119121
desc: Validate documentation build and check for issues

docs/images/grafana-dashboard.png

287 KB
Loading

docs/images/homepage-dashboard.png

203 KB
Loading

docs/images/uptime-kuma.png

354 KB
Loading

docs/roadmap.md

Lines changed: 197 additions & 260 deletions
Large diffs are not rendered by default.

stacks/apps/actual_server/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ services:
2525

2626
- homepage.group=Finance
2727
- homepage.name=Actual Budget
28-
- homepage.icon=actual.png
28+
- homepage.icon=mdi-cash-multiple
2929
- homepage.href=https://budget.${BASE_DOMAIN}/
3030
- homepage.description=Budgeting Application
3131

stacks/apps/librechat/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ services:
2929
- traefik.http.services.librechat.loadbalancer.server.port=3080
3030
- homepage.group=AI
3131
- homepage.name=LibreChat
32-
- homepage.icon=chat.png
32+
- homepage.icon=mdi-chat
3333
- homepage.href=https://chat.${BASE_DOMAIN}/
3434
- homepage.description=AI Chat Interface
3535
replicas: 1

stacks/apps/mlflow/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ services:
3030

3131
- homepage.group=Apps
3232
- homepage.name=MLflow
33-
- homepage.icon=mlflow.png
33+
- homepage.icon=mdi-brain
3434
- homepage.href=https://mlflow.${BASE_DOMAIN}/
3535
- homepage.description=MLflow Tracking
3636

stacks/dns/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ services:
2525

2626
- homepage.group=Infrastructure
2727
- homepage.name=DNS
28-
- homepage.icon=technitium-dns.png
28+
- homepage.icon=mdi-dns
2929
- homepage.href=https://dns.${BASE_DOMAIN}/
3030
- homepage.description=DNS Server (Swarm failover enabled)
3131
environment:

0 commit comments

Comments
 (0)