Commit 6277194cff6b50dae0b3577b10d9f1c7969c5b1a
1 parent
d9ef9dd9
README: document the publish step (add remote + push)
Showing
1 changed file
with
13 additions
and
0 deletions
README.md
| @@ -34,6 +34,19 @@ source .venv/bin/activate # if .venv missing: python3 -m venv .venv && | @@ -34,6 +34,19 @@ source .venv/bin/activate # if .venv missing: python3 -m venv .venv && | ||
| 34 | mkdocs serve # http://127.0.0.1:8000 with live reload | 34 | mkdocs serve # http://127.0.0.1:8000 with live reload |
| 35 | ``` | 35 | ``` |
| 36 | 36 | ||
| 37 | +## Publishing | ||
| 38 | + | ||
| 39 | +The repo is initialised but not yet pushed to a remote. To publish: | ||
| 40 | + | ||
| 41 | +```bash | ||
| 42 | +git remote add origin <your-remote-url> | ||
| 43 | +git push -u origin main | ||
| 44 | +``` | ||
| 45 | + | ||
| 46 | +Once the repo lives at a GitHub URL with Pages enabled (Settings → Pages | ||
| 47 | +→ Source: GitHub Actions), the workflow at `.github/workflows/publish.yml` | ||
| 48 | +will build and deploy the static site on every push to `main`. | ||
| 49 | + | ||
| 37 | ## Out-of-scope | 50 | ## Out-of-scope |
| 38 | 51 | ||
| 39 | - The B2B printing-platform layer (`plat_*` tables, `xlyPlat*` modules). | 52 | - The B2B printing-platform layer (`plat_*` tables, `xlyPlat*` modules). |