mirror of
https://github.com/storytold/lightcraft.git
synced 2026-10-24 10:09:01 -06:00
docs: drop the docs workflows until the checker is on artcraft-services main
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
7fe040f66a
commit
29ed703794
@@ -1,33 +0,0 @@
|
|||||||
name: docs-check
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths: ["docs/user/**"]
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
paths: ["docs/user/**"]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
env:
|
|
||||||
# Shared docs checker from storytold/artcraft-services, pinned to one commit
|
|
||||||
# and its SHA-256. To update it, change both values in a reviewed PR.
|
|
||||||
CHECKER_COMMIT: 4db0e30fe2c57a1c4c49e390e3711f90910b8d23
|
|
||||||
CHECKER_SHA256: bd6b610a708b85fd0aa0491c459bd2800b716e0b8050516fea79e084cfb2a624
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
check:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 22
|
|
||||||
- name: Download the pinned docs checker
|
|
||||||
run: |
|
|
||||||
url="https://raw.githubusercontent.com/storytold/artcraft-services/$CHECKER_COMMIT/frontend/apps/artcraft-website-next/scripts/docs/core.mjs"
|
|
||||||
curl -fsSL "$url" -o "$RUNNER_TEMP/docs-core.mjs"
|
|
||||||
echo "$CHECKER_SHA256 $RUNNER_TEMP/docs-core.mjs" | sha256sum -c -
|
|
||||||
- name: Check docs/user
|
|
||||||
run: node "$RUNNER_TEMP/docs-core.mjs" docs/user
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
name: docs-publish
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
paths: ["docs/user/**"]
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
rebuild:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Rebuild getartcraft.com
|
|
||||||
env:
|
|
||||||
HOOK: ${{ secrets.DOCS_BUILD_HOOK }}
|
|
||||||
run: |
|
|
||||||
if [ -z "$HOOK" ]; then
|
|
||||||
echo "DOCS_BUILD_HOOK is not set; the nightly website build will pick this up."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
curl -fsS -X POST -d '{}' "$HOOK?trigger_title=docs%20update%20from%20$GITHUB_REPOSITORY"
|
|
||||||
@@ -98,7 +98,7 @@ of it. Full standard: `../craftrules/standards/never-crash.md`
|
|||||||
## User docs
|
## User docs
|
||||||
User docs live in `docs/user/` and are published at https://getartcraft.com/docs/lightcraft. If a change alters
|
User docs live in `docs/user/` and are published at https://getartcraft.com/docs/lightcraft. If a change alters
|
||||||
something a user sees or does (menu or panel labels, import, export, install, errors), update the matching page in
|
something a user sees or does (menu or panel labels, import, export, install, errors), update the matching page in
|
||||||
`docs/user/` in the same commit, or add one. Rules: `docs/user/AGENTS.md`; the checker runs in `docs-check.yml`.
|
`docs/user/` in the same commit, or add one. Rules: `docs/user/AGENTS.md`.
|
||||||
Pages describe the latest release. For a change that is not released yet, write that it was added after <version>
|
Pages describe the latest release. For a change that is not released yet, write that it was added after <version>
|
||||||
and is not in a release yet, or update the page when the release ships.
|
and is not in a release yet, or update the page when the release ships.
|
||||||
|
|
||||||
|
|||||||
+2
-4
@@ -50,11 +50,9 @@ drafts and are not published.
|
|||||||
|
|
||||||
## Check before you push
|
## Check before you push
|
||||||
|
|
||||||
commit=$(awk '/CHECKER_COMMIT:/ {print $2}' .github/workflows/docs-check.yml)
|
node <path to your artcraft-services checkout>/frontend/apps/artcraft-website-next/scripts/docs/core.mjs docs/user
|
||||||
curl -fsSL "https://raw.githubusercontent.com/storytold/artcraft-services/$commit/frontend/apps/artcraft-website-next/scripts/docs/core.mjs" -o /tmp/docs-core.mjs
|
|
||||||
node /tmp/docs-core.mjs docs/user
|
|
||||||
|
|
||||||
This uses the same pinned checker as CI (`.github/workflows/docs-check.yml`).
|
The checker lives in storytold/artcraft-services. A CI check will be added once it is on that repo's main branch.
|
||||||
|
|
||||||
## Support PRs
|
## Support PRs
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user