LAB/rommapp_docs
1
0
Fork 0
mirror of https://github.com/rommapp/docs.git synced 2026-02-19 22:56:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add deployment instructions for documentation using mike

Browse Source
This commit is contained in:
zurdi 2025-02-24 09:32:25 +00:00
parent 931b2000a9
commit 1f73ee4355
No known key found for this signature in database
GPG Key ID: 767CE8BBDA9F73A9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -59,6 +59,16 @@ trunk fmt
trunk check
```
## Deploy
We use [mike]() to build and deploy documentation versions. Manually deploy a version needs to update and push the specific version (or a new one if creating a new version) with the following command:
```sh
uv run mike deploy --push <version> [alias]
```
This will update the `gh-pages` branch and automatically deploys the version with the fix/update to https://docs.romm.app
## Social
Join us on Discord, where you can ask questions, submit ideas, get help, showcase your collection, and discuss RomM with other users.