mirror of
https://github.com/storytold/designcraft.git
synced 2026-10-24 10:16:59 -06:00
Fabio LussiandClaude Opus 5.5
2dca7e220e
Baseline user docs in docs/user/ (published at getartcraft.com/docs/designcraft), the docs-check and docs-publish workflows, and a "User docs" rule in AGENTS.md. Source notes per page: - index.md: README (intro, features, license), website crafting-apps.ts entry. - getting-started/index.md: crates/ui-egui/src/chrome.rs start_screen buttons. - getting-started/install.md: README Downloads, gh release view v0.6.0 asset list, packaging/windows/designcraft.wxs (Start Menu shortcut), launcher catalog.rs. - guides/create-a-document.md: dialogs.rs newDocument dialog, build.rs PRESETS, menus.rs UI_COMMANDS, chrome.rs start screen. - guides/open-a-file.md: apps/designcraft main.rs open_filters, engine file.rs and interchange.rs docs, lib.rs import warnings test, issue #110. - guides/place-images-and-text.md: main.rs place filters, engine file.rs file.place, dialogs.rs pdfImport, menus.rs placeWithOptions, release notes (#80). - guides/export-a-pdf.md: dialogs.rs pdf_export and apply_pdf_preset, menus.rs. - troubleshooting/app-closes-at-start.md: README graphics backend and logs, apps/designcraft/src/gpu.rs, issues #167, #192, #220, #273. - troubleshooting/get-help.md: README Logs section. - faq/is-it-free.md: README, docs/gaps.md. faq/supported-systems.md: README, release assets. faq/indesign-files.md: main.rs open filters, issues #450, #451, #110. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
33 lines
887 B
YAML
33 lines
887 B
YAML
name: docs-check
|
|
|
|
on:
|
|
pull_request:
|
|
paths: ["docs/user/**"]
|
|
push:
|
|
branches: [main]
|
|
paths: ["docs/user/**"]
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
check:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 22
|
|
- name: Download the shared docs checker
|
|
id: fetch
|
|
run: |
|
|
url=https://raw.githubusercontent.com/storytold/artcraft-services/main/frontend/apps/artcraft-website-next/scripts/docs/core.mjs
|
|
if curl -fsSL "$url" -o "$RUNNER_TEMP/docs-core.mjs"; then
|
|
echo "ok=1" >> "$GITHUB_OUTPUT"
|
|
else
|
|
echo "::warning::The docs checker is not published yet; skipping."
|
|
fi
|
|
- name: Check docs/user
|
|
if: steps.fetch.outputs.ok == '1'
|
|
run: node "$RUNNER_TEMP/docs-core.mjs" docs/user
|