Publish user docs to git-pages
Some checks failed
ci / frontend-tests (push) Successful in 49s
ci / bridge-tests (push) Successful in 1m6s
ci / frontend-build (push) Successful in 1m4s
ci / backend-tests (push) Successful in 2m38s
ci / bridge-binary (amd64, linux) (push) Successful in 1m8s
ci / bridge-binary (amd64, windows) (push) Successful in 1m53s
ci / build-2 (push) Successful in 3m25s
ci / bridge-docker (push) Successful in 0s
ci / bridge-binary (arm64, darwin) (push) Successful in 1m37s
ci / bridge-binary (arm64, linux) (push) Successful in 1m7s
ci / build-1 (push) Successful in 5m8s
ci / frontend-docker (push) Successful in 0s
ci / server-binary (amd64, linux) (push) Successful in 1m46s
ci / server-binary (arm64, darwin) (push) Successful in 2m0s
ci / build-3 (push) Successful in 48s
ci / server-binary (arm64, linux) (push) Successful in 1m54s
ci / pages (push) Has been cancelled
ci / backend-docker (push) Successful in 0s
ci / server-binary (amd64, windows) (push) Successful in 2m48s
ci / build (push) Successful in 7m4s
ci / chart (push) Successful in 0s

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
Jonas Leder 2026-11-18 15:26:11 +01:00
commit 2c8b74ee29
5 changed files with 51 additions and 7 deletions

View file

@ -153,3 +153,48 @@ jobs:
name: bridge-${{ matrix.goos }}-${{ matrix.goarch }}
path: filamentmanagement-bridge-*
retention-days: 7
pages:
needs: [server-binary]
if: github.ref_type == 'branch' && github.ref_name == github.event.repository.default_branch
runs-on: default
container:
# must match documentation/package.json's pinned playwright version
image: mcr.microsoft.com/playwright:v1.65.1-noble
env:
DB_DRIVER: sqlite
DB_NAME: /tmp/fm-docs.db
REGISTRATION_ENABLED: 'true'
GIN_MODE: release
PORT: '8099'
steps:
- uses: https://code.forgejo.org/actions/checkout@v7
- uses: https://code.forgejo.org/forgejo/download-artifact@v7
with:
name: server-linux-amd64
- name: Build docs
run: |
chmod +x filamentmanagement-linux-amd64
./filamentmanagement-linux-amd64 &
node -e "
const url='http://localhost:8099/api/v1/settings/public';
(async () => {
for (let i = 0; i < 30; i++) {
try { const res = await fetch(url); if (res.ok) return; } catch {}
await new Promise(r => setTimeout(r, 1000));
}
throw new Error('server did not become ready');
})();
"
cd documentation
npm ci
SCREENSHOTS_BASE_URL=http://localhost:8099 npm run screenshots
npm run build
- name: Publish to git-pages
env:
GIT_PAGES_TOKEN: ${{ github.token }}
run: |
command -v curl >/dev/null || (apt-get update && apt-get install -y curl)
curl -fsSL -o git-pages-cli https://codeberg.org/git-pages/git-pages-cli/releases/download/v1.13.1/git-pages-cli.linux-amd64
chmod +x git-pages-cli
./git-pages-cli https://jonasled.jonasled.dev/filamentmanagement/ --upload-dir documentation/build

View file

@ -10,7 +10,7 @@ Rules:
## User-facing documentation (documentation/)
A Docusaurus site at `documentation/` is the **user** (not developer/ops) documentation, not deployed anywhere right now (the former GitLab Pages job was dropped in the Forgejo migration, see jonasled/k8s-flux issue 5). Docs live at `documentation/docs/**/*.md`, sidebar structure in `documentation/sidebars.js`.
A Docusaurus site at `documentation/` is the **user** (not developer/ops) documentation, published to git-pages at https://jonasled.jonasled.dev/filamentmanagement/ by the `pages` job in `.forgejo/workflows/ci.yml` (default branch only; screenshots are captured against the `server-linux-amd64` binary). Docs live at `documentation/docs/**/*.md`, sidebar structure in `documentation/sidebars.js`.
Rules:
- When you change or add user-visible behavior (a page, a feature, a setting, a flow a user would notice), update the relevant page under `documentation/docs/`. Don't document CI/ops internals, deployment pipelines, or anything a developer-only audience would want — that's explicitly out of scope for this site (see `deployment/` docs, which cover self-hosting only, not this repo's own CI).

View file

@ -2,7 +2,7 @@
A web app for managing filament spools, vendors, and inventory with a Go backend and a React + MUI frontend.
📖 [User documentation](https://filamentmanagement-3380ad.jonasled.dev/)
📖 [User documentation](https://jonasled.jonasled.dev/filamentmanagement/)
## Features

View file

@ -11,10 +11,9 @@ const config = {
v4: true,
},
// GitLab Pages (self-hosted) serves this project at its own unique
// subdomain of jonasled.dev, not a path under the group's domain.
url: 'https://filamentmanagement-3380ad.jonasled.dev',
baseUrl: '/',
// Published to git-pages as a path under jonasled.jonasled.dev (overridable via env).
url: process.env.DOCS_URL || 'https://jonasled.jonasled.dev',
baseUrl: process.env.DOCS_BASE_URL || '/filamentmanagement/',
organizationName: 'jonasled',
projectName: 'filamentmanagement',

View file

@ -48,7 +48,7 @@ import FeedbackSnackbar from './FeedbackSnackbar';
import { api } from '../api';
const drawerWidth = 240;
const helpUrl = 'https://filamentmanagement-3380ad.jonasled.dev';
const helpUrl = 'https://jonasled.jonasled.dev/filamentmanagement/';
function AppLayout({ user, children, onLogout, homeAssistantConfigured }) {
const [mobileOpen, setMobileOpen] = useState(false);