fix: docs Pages deploy permissions and document GitHub Pages setup

Deploy job failed because Pages source must be GitHub Actions; document
About/description guidance and fix workflow job permissions.
This commit is contained in:
O96u committed 2026-08-29 11:53:20 +08:00
1 parent 9b0a3f4944
commit 58a8e2082f
5 files changed
+53

No files matched your search

+11
View File
@@ -62,3 +62,14 @@ Use `data/mapping.json` from `migrate` preview. Keys are **storage paths**, not
## Docs vs README?
This **VitePress site** is the full guide; README is a short overview. Online: <https://o96u.github.io/PicHost/>
If you get 404, GitHub Pages may not be deployed yet: set **Settings → Pages → Source** to **GitHub Actions** and ensure the `docs` workflow `deploy` job succeeded. See [Local dev · Publish to GitHub Pages](./local-dev.md#publish-to-github-pages).
## What should the GitHub repo About say?
For **main**:
- **Description**: `Self-hosted image hosting — Docker, multi-user, S3/R2 storage, Twikoo/EasyImage compatible.`
- **Website**: `https://o96u.github.io/PicHost/` (docs, not a live demo)
Do not claim the app runs on Cloudflare Pages/Workers. The **cloudflare** branch demo is [pic.roven.cc](https://pic.roven.cc).
+12
View File
@@ -52,3 +52,15 @@ npm run docs:preview
```
Sources live in `docs-site/`; screenshot sources are in `docs/screenshots/` (including `login.png`), copied to `docs-site/public/screenshots/` before build.
## Publish to GitHub Pages
Live docs: <https://o96u.github.io/PicHost/>
**First-time setup** (if deploy fails or the site 404s):
1. Repo **Settings → Pages**
2. **Build and deployment → Source** → **GitHub Actions** (not “Deploy from a branch”)
3. Push to `main` or run the `docs` workflow manually from Actions
Allow 1–2 minutes after a successful deploy. If the `deploy` job fails immediately, Pages is usually not enabled yet.