You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-45Lines changed: 0 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,51 +10,6 @@ Project website and resources for the POMDAR benchmark.
10
10
11
11
Repo: **https://github.com/srl-ethz/POMDAR**
12
12
13
-
### Why assets sometimes “don’t show” (Git LFS vs Pages)
14
-
15
-
GitHub’s **default** Pages mode (**deploy from a branch**) publishes files **exactly as stored in Git**. For **Git LFS**, what’s stored in Git is a **small pointer file**, not the real binary. **GitHub Pages does not resolve LFS** in that mode — the browser receives pointers, so meshes/videos break. This is the same limitation discussed in the community thread: [“Can’t see LFS files on github website”](https://github.com/orgs/community/discussions/149620).
16
-
17
-
You have two workable approaches:
18
-
19
-
| Approach | What to do |
20
-
|----------|------------|
21
-
|**A. GitHub Actions deploy (this repo)**|**Settings → Pages → Source: GitHub Actions** (not “Deploy from a branch”). The workflow [`.github/workflows/deploy-pages.yml`](.github/workflows/deploy-pages.yml) runs `actions/checkout` with **`lfs: true`**, then uploads the **`docs/`** folder **with real LFS files expanded** — so `.mov` / `.stl` / etc. still in LFS in the repo, but the **published site** gets the actual bytes. |
22
-
|**B. Don’t use LFS for static web assets**| Keep small files (e.g. **`.obj` meshes**) as **normal Git blobs** so **any** Pages mode serves them. This repo stores **`.obj` in plain Git** for that reason. Very large media can be hosted on a **CDN / Releases** and linked by URL instead. |
23
-
24
-
**Do not** rely on branch-only deploy if the site must load LFS-tracked files, unless you use **A** or move those assets out of LFS (**B**).
25
-
26
-
---
27
-
28
-
## Publish / update the site
29
-
30
-
1. Push to **`main`**.
31
-
2.**Settings → Pages → Build and deployment → Source:****GitHub Actions**.
32
-
3. Wait for the **Deploy GitHub Pages** workflow (green check on the **Actions** tab).
33
-
4. Open **https://srl-ethz.github.io/POMDAR/**
34
-
35
-
If you still use **“Deploy from a branch”** → **`/docs`**, LFS-backed assets (e.g. **`.mov`**, **`.stl`**) will **not** work in the browser until you switch to **GitHub Actions** or stop using LFS for those paths.
36
-
37
-
---
38
-
39
-
## Git LFS (what stays in LFS)
40
-
41
-
See [`.gitattributes`](.gitattributes). Typical patterns:
-**Plain Git (not LFS):****`.obj`** MuJoCo meshes — small enough for normal Git and **required** for static serving if you ever use branch deploy without resolving LFS.
45
-
46
-
Install locally before push/clone:
47
-
48
-
```bash
49
-
brew install git-lfs # macOS
50
-
git lfs install
51
-
git lfs pull # after clone, fetch LFS objects
52
-
```
53
-
54
-
**GitHub limits:** normal Git rejects files **> 100 MB** per file. Large clips may need LFS or re-encoding. See [About Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-git-large-file-storage).
55
-
56
-
---
57
-
58
13
## Updating the site
59
14
60
15
Edit **`docs/`** (the deployed tree). Sync from your dev folder into `docs/` before committing.
0 commit comments