Skip to content

fix: docs build failure and add local example validation#50

Merged
cfoust merged 1 commit into
mainfrom
caleb/17-06-26/fix/ci
Jun 25, 2026
Merged

fix: docs build failure and add local example validation#50
cfoust merged 1 commit into
mainfrom
caleb/17-06-26/fix/ci

Conversation

@cfoust

@cfoust cfoust commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Summary

Fixes the docs build CI failure and adds a local command to run CI's Janet example validation.

  • pkg/cy/api/docs-signal.md — the signal/wait example blocks forever (nothing sends :my-channel in a standalone run), which timed out the example validator and failed the build. Marked # ignore like other blocking examples. The non-blocking signal/send example stays validated.
  • docs/docs/layouts.md — fixed a dynamic-property arity mismatch. The :title property now passes (size, layout), so border-title takes [size layout]. border-fg is preset with only the layout, so it stays [layout]. This clears the function takes at most 1 args, got 2 log lines.
  • justfile — added just docs-validate, which runs CI's exact example check locally. It clears both docs/.docusaurus and docs/node_modules/.cache so the markdown preprocessor actually re-runs; a stale webpack cache otherwise reuses processed output and silently skips validation.

Test plan

  • just docs-validate passes: 72 examples validated, 0 property errors.
  • Removing # ignore reproduces the exact CI failure (api.md:… timed out waiting for signal "my-channel", exit 1); restoring it passes.

🤖 Generated with Claude Code

The docs build was failing because the signal/wait example blocks
forever (nothing sends :my-channel in a standalone run), timing out
the Janet example validator. Mark it `# ignore` like other blocking
examples; the non-blocking signal/send example stays validated.

Also fix a dynamic-property arity mismatch in layouts.md: the :title
property now passes (size, layout), so border-title takes [size layout]
(border-fg is preset with only the layout, so it stays [layout]). This
clears the "function takes at most 1 args, got 2" log lines.

Add a `just docs-validate` recipe that runs CI's exact example check
locally. It clears both docs/.docusaurus and docs/node_modules/.cache
so the markdown preprocessor actually re-runs -- a stale webpack cache
otherwise reuses processed output and silently skips validation.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cfoust cfoust merged commit 96e7515 into main Jun 25, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant